From e455ddaab6e3076f6bf4f78584efaf8a61d80bc0 Mon Sep 17 00:00:00 2001 From: Cooper Lees Date: Wed, 31 Aug 2022 20:48:48 -0700 Subject: [PATCH] Update version + CHANGES.md for 6.0.0 release (#1199) - Add config options to docs explaining valid setting + docs fixes --- CHANGES.md | 4 ++-- docs/CONTRIBUTING.md | 2 +- docs/index.rst | 9 +++++++-- docs/mirror_configuration.md | 19 ++++++++++++++++++- setup.cfg | 2 +- src/bandersnatch/__init__.py | 2 +- 6 files changed, 30 insertions(+), 8 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 308c1f132..cf5e5b715 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -2,8 +2,8 @@ ## New Features -- Add PEP691 simple index support `PR #1154` -- Add example nginx serving for *PEP 691* `PR #1161` +- Add [PEP691](https://peps.python.org/pep-0691/) simple index support `PR #1154` +- Add example nginx serving for PEP 691 `PR #1161` # 5.3.0 (2022-07-29) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index f378f2e5b..b2be91b37 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -103,7 +103,7 @@ Docker is an easy way to get minio to run for tests to pass. docker run \ -p 9000:9000 \ -p 9001:9001 \ - --name minio1 \ + --name minio \ -v /Users/cooper/tmp/minio:/data \ minio/minio server /data --console-address ":9001" ``` diff --git a/docs/index.rst b/docs/index.rst index 1a8416070..21d1cee21 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,7 +13,12 @@ or packages since the last run's serial. bandersnatch then uses the JSON API of PyPI to get shasums and release file paths to download and workout where to layout the package files on a POSIX file system. -As of 4.0 bandersnatch: +As of 6.0: + +- Supports PEP691 + - HTML + JSON Simple Index + +As of 4.0: - Is fully asyncio based (mainly via aiohttp) - Only stores PEP503 nomalized packages names for the /simple API @@ -29,7 +34,7 @@ Contents -------- .. toctree:: - :maxdepth: 3 + :maxdepth: 4 installation storage_options diff --git a/docs/mirror_configuration.md b/docs/mirror_configuration.md index 1c4171640..3507aa192 100644 --- a/docs/mirror_configuration.md +++ b/docs/mirror_configuration.md @@ -226,10 +226,27 @@ proxy=http://myproxy.com By default bandersnatch downloads packages from the URL supplied in the master server server's json response. This option asks bandersnatch to try to download from the configured PyPI mirror first, and fallback to the URL supplied by the master server if it was not successful (unable to get content or checksum mismatch). -This is useful to sync most of the files from an existing, nearby mirror, for example when setting up a new server sitting next to an existing one for the purpose of load sharing. +This is useful to sync most of the files from an existing, nearby mirror, for example when setting up a new +server sitting next to an existing one for the purpose of load sharing. Example: ```ini [mirror] download-mirror = https://pypi-mirror.example.com/ ``` + +## simple-format + +Format for Simple API to be stored in. With PEP691 we now have HTML and JSON formats. + +Valid options are: + +- ALL +- HTML +- JSON + +Default: `ALL` formats + +```ini +simple-format = ALL +``` diff --git a/setup.cfg b/setup.cfg index 497885d56..ac0635934 100644 --- a/setup.cfg +++ b/setup.cfg @@ -16,7 +16,7 @@ project_urls = Source Code = https://github.com/pypa/bandersnatch Change Log = https://github.com/pypa/bandersnatch/blob/master/CHANGES.md url = https://github.com/pypa/bandersnatch/ -version = 6.0.0.dev0 +version = 6.0.0 [options] install_requires = diff --git a/src/bandersnatch/__init__.py b/src/bandersnatch/__init__.py index f639b3985..47f5c7386 100644 --- a/src/bandersnatch/__init__.py +++ b/src/bandersnatch/__init__.py @@ -22,7 +22,7 @@ def version_str(self) -> str: major=6, minor=0, micro=0, - releaselevel="dev0", + releaselevel="", serial=0, # Not currently in use with Bandersnatch versioning ) __version__ = __version_info__.version_str