Skip to content

Update quickstart auth docs for self-serve API keys#58

Merged
daniel-k merged 6 commits into
masterfrom
update-to-self-serve-api-keys
Jun 1, 2026
Merged

Update quickstart auth docs for self-serve API keys#58
daniel-k merged 6 commits into
masterfrom
update-to-self-serve-api-keys

Conversation

@julius-scheu
Copy link
Copy Markdown
Contributor

@julius-scheu julius-scheu commented Jun 1, 2026

What

Updates the Authentication section of the quickstart docs to reflect that API keys can now be created and managed self-serve within the ENLYZE platform.

  • Replaces the "reach out to us at hello@enlyze.com" flow with a link to the Creating and Managing API Keys documentation.
  • Aligns terminology from "access token" to "API key" throughout (including the client setup example).
  • Keeps the safety guidance and updates the lost/compromised note to reflect that keys are now self-revocable.

API keys can now be created and managed self-serve within the ENLYZE
platform, so replace the "reach out to us" flow with a link to the
API keys documentation. Also align terminology from "access token"
to "API key".

Closes #543

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@julius-scheu julius-scheu requested a review from daniel-k June 1, 2026 09:54
Copy link
Copy Markdown
Member

@daniel-k daniel-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one minor issue, otherwise LGTM

Comment thread docs/quickstart.rst Outdated
@denizs
Copy link
Copy Markdown
Member

denizs commented Jun 1, 2026

CI is failing

julius-scheu and others added 4 commits June 1, 2026 13:44
Co-authored-by: Daniel Roussel <daniel-k@users.noreply.github.com>
pyproject-fmt 2.23.0 imports tomli (stdlib tomllib is 3.11+) without
declaring it as a dependency, so the lint job crashes on the Python
3.10 matrix entries with "No module named 'tomli'". Add tomli to the
pyproject-fmt tox env for Python <3.11.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sphinx autodoc renders the pandas.DataFrame return annotations on
TimeseriesData.to_dataframe and ProductionRuns.to_dataframe using the
fully-qualified pandas.core.frame.DataFrame, which pandas does not
publish in its intersphinx inventory. Under nitpicky mode with -W this
emits 2 warnings-as-errors that fail the docs, docs-spellcheck and
docs-linkcheck builders. Add the internal class to nitpick_ignore.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 1, 2026

Coverage results

This is the coverage report for commit ab25ea4

Name                                                               Stmts   Miss  Cover   Missing
------------------------------------------------------------------------------------------------
.tox/py/lib/python3.12/site-packages/enlyze/__init__.py                4      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/api_client/client.py      82      1    99%   143
.tox/py/lib/python3.12/site-packages/enlyze/api_client/models.py      85      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/auth.py                   13      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/client.py                105      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/constants.py               6      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/errors.py                  4      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/iterable_tools.py          7      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/models.py                117      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/schema.py                 25      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/validators.py             38      0   100%
------------------------------------------------------------------------------------------------
TOTAL                                                                486      1    99%

2 empty files skipped.

@daniel-k daniel-k merged commit b993547 into master Jun 1, 2026
12 checks passed
@daniel-k daniel-k deleted the update-to-self-serve-api-keys branch June 1, 2026 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants