Skip to content

Commit

Permalink
Apply markdown fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@RobertRosca
RobertRosca committed Nov 4, 2022
1 parent 6b06e06 commit 08d01d0
Show file tree
Hide file tree
Showing 8 changed files with 82 additions and 91 deletions.
46 changes: 12 additions & 34 deletions CHANGES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
- Add bandersnatch command line help to the documentation main page `PR #920` - Thanks **ichard26**
- Generate data-yanked tag in simple page `PR #931` - Thanks **happyaron**
- Protect repository metadata from being trashed when disk is full `PR #962` - Thanks **happyaron**
- Fix tox to used pinned requirements*.txt files for deps - `PR #1011` - Thanks **cooperlees**
- Fix tox to used pinned requirements\*.txt files for deps - `PR #1011` - Thanks **cooperlees**

## Documentation

Expand Down Expand Up @@ -107,7 +107,7 @@
- Migrated Markdown documentation from recommonmark to MyST-Parser + docs config clean up - `PR #879` - Thanks **ichard26**
- Use `shutil.move()` for temp file management - `PR #883` - Thanks **happyaron**
- Fixed logging bug in `SizeProjectMetadataFilter` to show it activated - `PR #889` - Thanks **cooperlees**
- Attempt to wrap all potentially block calls in a ThreadPoolExecutor - `PR #894` - Thanks **cooperlees**`
- Attempt to wrap all potentially block calls in a ThreadPoolExecutor - `PR #894` - Thanks **cooperlees**

# 4.4.0 (2020-12-31)

Expand Down Expand Up @@ -158,12 +158,12 @@ Thanks to RedHat engineers **@dalley** + **@gerrod3** for all this refactor work

- Old Mirror class has been renamed to BandersnatchMirror. Performs same functionality with use of new Mirror API.
- BandersnatchMirror now performs all filesystem operations throughout the sync process including the ones previously
in Package.
in Package.
- Package no longer performs filesystem operations. Properties `json_file`, `json_pypi_symlink`, `simple_directory`
and methods `save_json_metadata`, `sync_release_files`, `gen_data_requires_python`, `generate_simple_page`,
`sync_simple_page`, `_save_simple_page_version`, `_prepare_versions_path`, `_file_url_to_local_url`,
`_file_url_to_local_path`, `download_file` have all been moved into BandersnatchMirror. Package's `sync` has been
refactored into Bandersnatch's `process_package`.
and methods `save_json_metadata`, `sync_release_files`, `gen_data_requires_python`, `generate_simple_page`,
`sync_simple_page`, `_save_simple_page_version`, `_prepare_versions_path`, `_file_url_to_local_url`,
`_file_url_to_local_path`, `download_file` have all been moved into BandersnatchMirror. Package's `sync` has been
refactored into Bandersnatch's `process_package`.
- Package class is no longer created with an instance of Mirror
- StaleMetadata exception has been moved to new errors.py file
- PackageNotFound exception has been moved to new errors.py file
Expand Down Expand Up @@ -292,6 +292,7 @@ and methods `save_json_metadata`, `sync_release_files`, `gen_data_requires_pytho
- Many pyup.io dependency upgrades

### Known Bug

- From 3.0.0 we've been implicitly turning on *ALL* plugins - This version reverses that

## 3.1.3 (2018-12-26)
Expand Down Expand Up @@ -342,22 +343,19 @@ and methods `save_json_metadata`, `sync_release_files`, `gen_data_requires_pytho
- Allow digest_name to be specified. `Fixes #105` - Thanks **@ewdurbin** !
- synchronize generated index pages with warehouse - Thanks **@ewdurbin** !
- Allow root_uri to be configured - Thanks **@ewdurbin** !
-- This is how warehouse (pypi.org) will function

- This is how warehouse (pypi.org) will function

## 2.1.3 (2018-03-04)

- Change version from using pkg_resources and set it in package __init__.py.
`Fixes #98`.
- Add ability to blacklist packages to sync via conf file. `Fixes #100`.


## 2.1.2

- Add saving of JSON metadata grabbed from pypi.facebook.com for syncing `Fixes #91` - Thanks **@cooperlees**
-- Can be disabled via config and disabled by default
-- bandersnatch symlinks WEB_ROOT/pypi/PKG_NAME/json to WEB_ROOT/json/PKG_NAME

- Can be disabled via config and disabled by default
- bandersnatch symlinks WEB_ROOT/pypi/PKG_NAME/json to WEB_ROOT/json/PKG_NAME

## 2.1.0

Expand All @@ -371,7 +369,6 @@ and methods `save_json_metadata`, `sync_release_files`, `gen_data_requires_pytho
file with the 'hidden' filename of the destination adding more
support for hashed POSIX filesystems like GlusterFS. - Thanks **@cooperlees**


# 2.0.0 (2017-04-05)

- Move to Python 3. - Thanks **@cooperlees** !
Expand All @@ -392,7 +389,6 @@ and methods `save_json_metadata`, `sync_release_files`, `gen_data_requires_pytho

- Make the package-specific simple pages human-readable again. `Fixes #71`.


## 1.11 (2016-05-18)

- Add option to dir-hash index files. See
Expand All @@ -403,16 +399,13 @@ and methods `save_json_metadata`, `sync_release_files`, `gen_data_requires_pytho
could result in crashing workers that would result in bandersnatch
getting stuck. Thanks **@wjjt**!


## 1.10.0.1 (2016-05-11)

- Brownbag release for re-upload. My train's Wifi broke while uploading
ending up with a partial file on PyPI. Can your train service do better
than mine?


1.10 (2016-05-11)
-----------------
## 1.10 (2016-05-11)

This is release is massively supported by **@dstufft** getting bandersnatch
back in sync with current packaging ecosystem changes. All clap your hands
Expand All @@ -428,13 +421,11 @@ now, please.
- Implement PEP 503 normalization rules while also providing support
for legacy and very legacy clients.


## 1.9 (2016-04-21)

- Fix a long standing, misunderstood bug: a non-deleting mirror would
delete packages if they were fully removed from PyPI. `Fixes #61`


## 1.8 (2015-03-16)

- Don't require a X-PyPI-Last-Serial header on file downloads.
Expand All @@ -443,15 +434,13 @@ now, please.
- Increase our generation to help mirrors recover potential
setuptools corruption after some data bug on PyPI.


## 1.7 (2014-12-14)

- Fixes #54 by reordering the simple index page and file fetching
parts. Thanks **@dstufft** for the inspiration.

- Stop syncing serversig files and even start removing them.


## 1.6.1 (2014-09-24)

- Create a new generation to enforce a full sync when upgrading.
Expand Down Expand Up @@ -488,20 +477,17 @@ now, please.
- Potential performance improvement: use requests' session object to allow HTTP
pipelining. Thanks to Wouter Bolsterlee for the recommendation in `Fixes #39`.


## 1.1 (2013-11-26)

- Made code Python 2.6 compatible. Thanks to **@ewdurbin** for the pull request.


## 1.0.5 (2013-07-25)

- Refactor lock acquisition to avoid shadowing exceptions when creating the
lockfile vs. acquiring the lock.

- Move from distribute back to setuptools.


## 1.0.4 (2013-07-10)

- Slight brownbag release: the requirements.txt accidentally included a
Expand All @@ -512,7 +498,6 @@ now, please.
- Fix brownbag release with broken 'stable' tag and missing requirements.txt
update.


## 1.0.2 (2013-07-08)

- Generate the index simple page ourselves: its not signed anyway and helps
Expand All @@ -536,7 +521,6 @@ now, please.

- Fix packaging: include default config file. (Thanks to **Jannis Leidel**)


# 1.0 (2013-04-09)

- Update pip install documentation to use the a URL for referring to the
Expand All @@ -549,32 +533,26 @@ now, please.

- Hopefully fixed updating the stable tag when releasing.


## 1.0rc5 (2013-04-09)

- Experiment with zest.releaser integration to automatically generate
requirements.txt during release process.


## 1.0rc4 (2013-04-09)
-------------------

- Experiment with zest.releaser integration to automatically generate
requirements.txt during release process.


## 1.0rc3 (2013-04-09)

- Experiment with zest.releaser integration to automatically generate
requirements.txt during release process.


## 1.0rc2 (2013-04-09)

- Experiment with zest.releaser integration to automatically generate
requirements.txt during release process.


## 1.0rc1 (2013-04-09)

- Initial release. Massive rewrite of pep381client.
5 changes: 3 additions & 2 deletions MAINTAINERS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,15 @@ compatible way like a PEP381 mirror. Simple is always better than complex and al
issues need to be reproducible for our developers.

#### pyup.io

- Remember it's not perfect
- It does not take into account modules pinned dependencies
- e.g. If requests wants *urllib3<1.25* *pyup.io* can still try and update it
- e.g. If requests wants *urllib3\<1.25* *pyup.io* can still try and update it
- Until we have **CI** that effectively runs `pip freeze` from time to time we
should recheck our minimal deps that we pin in `requirements.txt`

### Releasing to PyPI

Every maintainer can release to PyPI. A maintainer should have agreement of
two or more Maintainers that it is a suitable time for a release.

Expand All @@ -51,7 +53,6 @@ two or more Maintainers that it is a suitable time for a release.
- Build a `sdist` + `wheel`
- Use `twine` to upload to PyPI


### Building Docker Image

example build commands
Expand Down
28 changes: 14 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
[![Documentation Status](https://readthedocs.org/projects/bandersnatch/badge/?version=latest)](http://bandersnatch.readthedocs.io/en/latest/?badge=latest)
[![Downloads](https://pepy.tech/badge/bandersnatch)](https://pepy.tech/project/bandersnatch)

----
______________________________________________________________________

This is a PyPI mirror client according to `PEP 381` + `PEP 503` + `PEP 691`
http://www.python.org/dev/peps/pep-0381/.
<http://www.python.org/dev/peps/pep-0381/>.

- bandersnatch >=6.0 implements PEP691
- bandersnatch >=4.0 supports *Linux*, *MacOSX* + *Windows*
Expand Down Expand Up @@ -55,21 +55,21 @@ bandersnatch/bin/bandersnatch --help

## Quickstart

- Run ``bandersnatch mirror`` - it will create an empty configuration file
for you in ``/etc/bandersnatch.conf``.
- Review ``/etc/bandersnatch.conf`` and adapt to your needs.
- Run ``bandersnatch mirror`` again. It will populate your mirror with the
- Run `bandersnatch mirror` - it will create an empty configuration file
for you in `/etc/bandersnatch.conf`.
- Review `/etc/bandersnatch.conf` and adapt to your needs.
- Run `bandersnatch mirror` again. It will populate your mirror with the
current status of all PyPI packages.
Current mirror package size can be seen here: https://pypi.org/stats/
- A ``blocklist`` or ``allowlist`` can be created to cut down your mirror size.
Current mirror package size can be seen here: <https://pypi.org/stats/>
- A `blocklist` or `allowlist` can be created to cut down your mirror size.
You might want to [Analyze PyPI downloads](https://packaging.python.org/guides/analyzing-pypi-package-downloads/)
to determine which packages to add to your list.
- Run ``bandersnatch mirror`` regularly to update your mirror with any
- Run `bandersnatch mirror` regularly to update your mirror with any
intermediate changes.

### Webserver

Configure your webserver to serve the ``web/`` sub-directory of the mirror.
Configure your webserver to serve the `web/` sub-directory of the mirror.
For PEP691 support we need to respect the format the client requests.

For an [nginx](https://www.nginx.com/) example, please look at our
Expand Down Expand Up @@ -98,7 +98,7 @@ Here's a sample that you could place in `/etc/cron.d/bandersnatch`:
*/2 * * * * root bandersnatch mirror |& logger -t bandersnatch[mirror]
```

This assumes that you have a ``logger`` utility installed that will convert the
This assumes that you have a `logger` utility installed that will convert the
output of the commands to syslog entries.

[SystemD Timers](https://www.freedesktop.org/software/systemd/man/systemd.timer.html)
Expand Down Expand Up @@ -164,7 +164,7 @@ An example of an unsupported API is [PyPI's XML-RPC interface](https://warehouse

The bandersnatch project strives to:

- Mirror all static objects of the Python Package Index (https://pypi.org/)
- Mirror all static objects of the Python Package Index (<https://pypi.org/>)
- bandersnatch's main goal is to support the main global index to local syncing **only**
- This will allow organizations to have lower latency access to PyPI and
save bandwidth on their WAN connections and more importantly the PyPI CDN
Expand All @@ -174,9 +174,9 @@ The bandersnatch project strives to:
### Contact

If you have questions or comments, please submit a bug report to
https://github.com/pypa/bandersnatch/issues/new
<https://github.com/pypa/bandersnatch/issues/new>

- Discord: #bandersnatch now sit in the *PyPA Discord* server. To join visit https://discord.com/invite/pypa
- Discord: #bandersnatch now sit in the *PyPA Discord* server. To join visit <https://discord.com/invite/pypa>

### Code of Conduct

Expand Down
12 changes: 6 additions & 6 deletions docs/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Successfully installed pip-10.0.1

- Then install the dependencies to the venv:

``` console
```console
/path/to/venv/bin/pip install -r requirements.txt -r test-requirements.txt
```

Expand Down Expand Up @@ -93,7 +93,7 @@ Congrats, now you have a bandersnatch development environment ready to go! Just
S3 unittests are more integration tests. They depend on [minio](https://docs.min.io/) to work.

- You will either need to skip them or install mino
- Install options: https://docs.min.io/docs/
- Install options: <https://docs.min.io/docs/>

#### Docker Install

Expand Down Expand Up @@ -137,7 +137,7 @@ You will need to customize `src/bandersnatch/default.conf` and run via the follo

**WARNING: Bandersnatch will go off and sync from pypi.org and use large amounts of disk space!**

``` console
```console
cd bandersnatch
/path/to/venv/bin/pip install --upgrade .
/path/to/venv/bin/bandersnatch -c src/bandersnatch/default.conf mirror
Expand Down Expand Up @@ -211,11 +211,11 @@ GitHub actions to build and upload our releases.
- To cut a release first make a PR updating:
- the version in `setup.cfg` + `src/badnersnatch/__init__.py`
- Update `CHANGES.md`. Here check for typos + missing commits that should be mentioned
- Example PR: https://github.com/pypa/bandersnatch/pull/1069
- Example PR: <https://github.com/pypa/bandersnatch/pull/1069>
- THen, once merged and CI is passing
- Cut a [GitHub Release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
and GitHub Actions will package and upload to PyPI.
- https://github.com/pypa/bandersnatch/releases
and GitHub Actions will package and upload to PyPI.
- <https://github.com/pypa/bandersnatch/releases>
- Select "Draft a new release"

### Conventions
Expand Down
Loading

0 comments on commit 08d01d0

Please sign in to comment.