From c4c0883db0ec87ec66186c2399d8a23dcf2006f9 Mon Sep 17 00:00:00 2001 From: Joshua Tzucker Date: Wed, 13 Nov 2024 01:39:32 -0800 Subject: [PATCH] Docs (remove notes about private repo, cleanup) --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c8f0987..5fdf5b5 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ - Support for automated debugpy listener - Support for `requirements()` markers - Support for test collection, with CSV export (including with xdist) +- An extensible static file serving class / middleware, which has a few bells and whistles in comparison to the default `serve()` method - Logging utils (presets, formatters, etc.) - CLI / pre-built commands (see [](./django_utils_lib/commands.py)) - CLI Utils @@ -16,7 +17,7 @@ ## Installing and Using (as a library) -While this repo is private, you can still install it in various projects by using the git origin as the source. +While this project is not published on `pypi`, you can still install it in various projects by using the git origin as the source. For example, [with Poetry](https://python-poetry.org/docs/dependency-specification/#git-dependencies), you can use: @@ -24,11 +25,6 @@ For example, [with Poetry](https://python-poetry.org/docs/dependency-specificati poetry add git+https://github.com/innolitics/django-utils-lib.git#REFERENCE ``` -> [!WARNING] -> Under the hood, your package manager needs to be able to authenticate against the git URL that you use. Locally, this should "Just Work", but in CI, you will need to give CI a token to access the repo (even if CI is running inside another `github.com/innolitics` repo). -> -> For CI purposes, you can use a read-only [GitHub deploy key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys), as an easier alternative to managing PATs or fine-grained access tokens. - ## Pytest plugin ### Pytest Plugin - Discovery / Registration @@ -73,4 +69,4 @@ poetry add --editable ${LOCAL_PATH_TO_THIS_DIRECTORY} ### Publishing -TBD; right now this is only available internally at Innolitics (and/or for our clients), as a private repo. +TBD; right now this is not published on `pypi`, but is available publicly.