Skip to content

Commit e455dda

Browse files
authored
Update version + CHANGES.md for 6.0.0 release (#1199)
- Add config options to docs explaining valid setting + docs fixes
1 parent 785aa61 commit e455dda

File tree

6 files changed

+30
-8
lines changed

6 files changed

+30
-8
lines changed

CHANGES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
## New Features
44

5-
- Add PEP691 simple index support `PR #1154`
6-
- Add example nginx serving for *PEP 691* `PR #1161`
5+
- Add [PEP691](https://peps.python.org/pep-0691/) simple index support `PR #1154`
6+
- Add example nginx serving for PEP 691 `PR #1161`
77

88
# 5.3.0 (2022-07-29)
99

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Docker is an easy way to get minio to run for tests to pass.
103103
docker run \
104104
-p 9000:9000 \
105105
-p 9001:9001 \
106-
--name minio1 \
106+
--name minio \
107107
-v /Users/cooper/tmp/minio:/data \
108108
minio/minio server /data --console-address ":9001"
109109
```

docs/index.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,12 @@ or packages since the last run's serial. bandersnatch then uses the JSON API
1313
of PyPI to get shasums and release file paths to download and workout where
1414
to layout the package files on a POSIX file system.
1515

16-
As of 4.0 bandersnatch:
16+
As of 6.0:
17+
18+
- Supports PEP691
19+
- HTML + JSON Simple Index
20+
21+
As of 4.0:
1722

1823
- Is fully asyncio based (mainly via aiohttp)
1924
- Only stores PEP503 nomalized packages names for the /simple API
@@ -29,7 +34,7 @@ Contents
2934
--------
3035

3136
.. toctree::
32-
:maxdepth: 3
37+
:maxdepth: 4
3338

3439
installation
3540
storage_options

docs/mirror_configuration.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,10 +226,27 @@ proxy=http://myproxy.com
226226
By default bandersnatch downloads packages from the URL supplied in the master server server's json response.
227227
This option asks bandersnatch to try to download from the configured PyPI mirror first, and fallback to the
228228
URL supplied by the master server if it was not successful (unable to get content or checksum mismatch).
229-
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.
229+
This is useful to sync most of the files from an existing, nearby mirror, for example when setting up a new
230+
server sitting next to an existing one for the purpose of load sharing.
230231

231232
Example:
232233
```ini
233234
[mirror]
234235
download-mirror = https://pypi-mirror.example.com/
235236
```
237+
238+
## simple-format
239+
240+
Format for Simple API to be stored in. With PEP691 we now have HTML and JSON formats.
241+
242+
Valid options are:
243+
244+
- ALL
245+
- HTML
246+
- JSON
247+
248+
Default: `ALL` formats
249+
250+
```ini
251+
simple-format = ALL
252+
```

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ project_urls =
1616
Source Code = https://github.com/pypa/bandersnatch
1717
Change Log = https://github.com/pypa/bandersnatch/blob/master/CHANGES.md
1818
url = https://github.com/pypa/bandersnatch/
19-
version = 6.0.0.dev0
19+
version = 6.0.0
2020

2121
[options]
2222
install_requires =

src/bandersnatch/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def version_str(self) -> str:
2222
major=6,
2323
minor=0,
2424
micro=0,
25-
releaselevel="dev0",
25+
releaselevel="",
2626
serial=0, # Not currently in use with Bandersnatch versioning
2727
)
2828
__version__ = __version_info__.version_str

0 commit comments

Comments
 (0)