You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f31bbfe
Browse filesBrowse the repository at this point in the historyBrowse files
- Bumped `setuptools` version requirement in `pyproject.toml` to ensure compatibility with newer features.
- Added `license-files` entry in `pyproject.toml` for better license management.
- Expanded `README.md` with additional usage examples for the `auralog` helper function, improving clarity for users.
- Updated `dev-docs/README.md` to include project description, package naming conventions, and publishing setup details for maintainers.
Copy file name to clipboardExpand all lines: README.md
+34-20Lines changed: 34 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,18 @@
2
2
3
3
Command-line client for [Auralogger](https://auralogger.com): `init`, `server-check`, `client-check`, `test-serverlog`, `test-clientlog`, and `get-logs`, plus the `aura_log` helper for Python apps.
4
4
5
+
```text
6
+
├── LICENSE
7
+
├── pyproject.toml
8
+
├── README.md
9
+
```
10
+
11
+
## Package naming (Node vs Python)
12
+
13
+
- Python distribution name: `auralogger` (install with `pip install auralogger`)
14
+
- Node distribution name: `auralogger-cli` (install with `npm install auralogger-cli`)
15
+
- Both expose the CLI command `auralogger`, but package names on package indexes are intentionally different.
16
+
5
17
## Install
6
18
7
19
From [PyPI](https://pypi.org/) (once published):
@@ -22,8 +34,6 @@ The CLI uses **your shell’s current working directory** as the project root. I
22
34
23
35
Configuration is **environment variables** only — see **`user-docs/environment.md`** for **`AURALOGGER_PROJECT_TOKEN`**, **`AURALOGGER_USER_SECRET`**, and the publishable `AURALOGGER_PROJECT_*` keys. There is no `auralogger.config.json`.
24
36
25
-
**Wire contract (matches Node):**`proj_auth` is **`POST /api/{project_token}/proj_auth`** with the token in the path only. **`get-logs`** uses **`POST /api/{project_token}/logs`** with headers **`secret`** and **`user_secret`** both set to your **user secret**. The server ingest socket is **`WS /{project_token}/create_log`** with **`Authorization: Bearer <user_secret>`**. Set **`AURALOGGER_PROJECT_TOKEN`** and **`AURALOGGER_USER_SECRET`**; legacy **`AURALOGGER_PROJECT_SECRET`** is treated as the user secret (with a deprecation warning) if **`AURALOGGER_USER_SECRET`** is unset.
26
-
27
37
```bash
28
38
cd /path/to/my-app
29
39
auralogger init
@@ -63,6 +73,28 @@ auralog(
63
73
)
64
74
```
65
75
76
+
## Using the generated `auralog(...)` helper
77
+
78
+
After `auralogger init`, paste the server snippet into your app (for example `your_server_auralog_file.py`), then use it like this:
Releases are automated through `.github/workflows/python-publish.yml`.
100
-
101
-
- The workflow runs on GitHub release publish events only when the tag matches `python-v*` (for example, `python-v0.1.1`), or through manual `workflow_dispatch`.
102
-
- Configure repository secret `PYPI_API_TOKEN` with a PyPI API token.
103
-
- Before tagging, bump `version` in `python/pyproject.toml` and update `python/CHANGELOG.md`.
104
-
105
-
Manual fallback from this directory, after configuring PyPI credentials (`twine`):
106
-
107
-
```bash
108
-
python -m pip install build twine
109
-
python -m build
110
-
twine upload dist/*
111
-
```
112
-
113
-
End users only need `pip install auralogger` once the release is on PyPI.
`auralogger` (Python): command-line client for Auralogger: `init`, `server-check`, `client-check`, `test-serverlog`, `test-clientlog`, and `get-logs`, plus the `aura_log` helper for Python apps.
12
+
13
+
```text
14
+
├── LICENSE
15
+
├── pyproject.toml
16
+
├── README.md
17
+
```
18
+
19
+
## Package naming (Node vs Python)
20
+
21
+
- Python distribution name: `auralogger` (`pip install auralogger`)
22
+
- Node distribution name: `auralogger-cli` (`npm install auralogger-cli`)
23
+
- Both expose the CLI command `auralogger`, but package-index names are intentionally different.
24
+
5
25
## Start here
6
26
7
27
-`file-map.md`: quick map of what each important module does
8
28
-`routes.md`: HTTP + WebSocket routes and where they are used in this package
9
29
10
30
Auth contract (match Node / hosted API): **`POST /api/{project_token}/proj_auth`** — token in path only. **`POST /api/{project_token}/logs`** — headers **`secret`** and **`user_secret`** both set to the **user secret**. Server ingest WebSocket — **`Authorization: Bearer <user_secret>`** on **`/{project_token}/create_log`**.
0 commit comments