Draft: 🚀 v1.0.3 | development docs

.bumpversion.cfg

@@ -8,10 +8,6 @@ message = 📦 v{new_version} is available, upgrade from {current_version}
 search = version="{current_version}"
 replace = version="{new_version}"
 
-[bumpversion:file:docs/conf.py]
-search = version = release = "{current_version}"
-replace = version = release = "{new_version}"
-
 [bumpversion:file:src/pastebin_bisque/__init__.py]
 search = __version__ = "{current_version}"
 replace = __version__ = "{new_version}"

.github/workflows/github-actions.yml

@@ -9,11 +9,6 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - name: 'docs'
-            python: '3.11'
-            toxpython: 'python3.11'
-            tox_env: 'docs'
-            os: 'ubuntu-latest'
           - name: 'py39-cover (ubuntu)'
             python: '3.9'
             toxpython: 'python3.9'

AUTHORS.md

@@ -0,0 +1,3 @@
+# ✍️ Authors
+
+-   🦄 Brie Carranza - <https://brie.dev>

CHANGELOG.md

@@ -0,0 +1,42 @@
+# 🎉 Changelog
+
+## 1.0.0 (09/10/2023)
+
+v1.0.0: 🍰 Now On PyPI
+
+With this release, `pastebin-bisque` is now available on PyPI. You can 
+install it with:
+
+    pip install pastebin-bisque
+
+This release is timed as an early celebration of the 🦄🌈 [original
+author](https://brie.dev/about)'s 🍰 birthday.
+
+## 0.3.0 (12/11/2022)
+
+v0.3.0: 🤖🤝 Human and Bot Friendly
+
+This release is friendly for both humans *and* machines. Thanks to [your
+feedback](https://github.com/bbbbbrie/pastebin-bisque/issues/6), I
+pushed a new release that should make for a much better experience all
+around.
+
+### What\'s Changed
+
+-   Bump urllib3 from 1.25.8 to 1.26.5 by `@dependabot`
+-   Address feedback in
+    [#6](https://github.com/bbbbbrie/pastebin-bisque/issues/6) by Brie
+    Carranza in [#8](https://github.com/bbbbbrie/pastebin-bisque/pull/8)
+
+## 0.2.0 (05/13/2020)
+
+v0.2.0: Tidied Up
+
+This version has neater output.
+
+## 0.1.0 (03/01/2020)
+
+v0.1.0: Inaugural Release
+
+This is the first release of Pastebin Bisque! All of the initial bugs
+have been squashed! There is documentation and a demo. 😸

README.md

@@ -0,0 +1,74 @@
+# ✨ Overview ✨
+
+The Pastebin Bisque is a small Python utility that uses BeautifulSoup to scrape a user's [Pastebin](https://pastebin.com/) profile. All public pastes from that user are downloaded to disk. Optionally, the pastes can be saved to a single `.zip` file.
+
+There is no rate-limiting protection built-in. Read about the [Pastebin Request Limits](https://pastebin.com/doc_scraping_api#2) if you anticipate generating a large number of requests. The file name provided by the Pastebin user will be prepended with the short URL that Pastebin provides. This allows a single directory with all pastes and no duplicates and makes the original URL fairly easy to reconstruct.
+
+TL;DR - Scrape all public Pastebin pastes from a user.
+
+Free software: GNU Lesser General Public License v3 or later (LGPLv3+)
+
+## 📦 Installation
+
+    pip install pastebin-bisque
+
+Learn more on [PyPI](https://pypi.org/project/pastebin-bisque/).
+
+## ℹ️ Usage
+
+    pastebin-bisque
+
+Specify a username:
+
+    pastebin-bisque --username catstestingcode
+
+Zip the results:
+
+    pastebin-bisque -z
+
+Download all of the public pastes for the `catstestingcode` user and save them in a `.zip` file:
+
+    pastebin-bisque --username catstestingcode -z
+
+## 📚 Documentation
+
+The documentation for `pastebin-bisque` is served via [Read the Docs](https://readthedocs.org) and is available at:
+
+<https://pastebin-bisque.readthedocs.io/>
+
+## 💻 Development
+
+🙏 Thanks for your interest in contributing to the development (and documentation) of `pastebin-bisque`. See the notes on [contributing](CONTRIBUTING.md) to learn more.
+
+### 🧪 Tests
+
+This project uses [GitLab CI](https://docs.gitlab.com/ee/ci/), [tox](https://tox.wiki/en/4.11.3/) and [Test PyPI](https://packaging.python.org/en/latest/guides/using-testpypi/) for testing. See `tests/test_pastebin_bisque.py`.
+
+#### 🏡 Local
+
+To run all the tests run:
+
+    tox
+
+Consider using this to run the tests in parallel:
+
+> tox -p auto
+
+Note, to combine the coverage data from all the tox environments:
+
+##### Windows 
+
+```shell
+set PYTEST_ADDOPTS=--cov-append
+tox
+```
+
+##### Other Platforms
+
+```shell
+PYTEST_ADDOPTS=--cov-append tox
+```
+
+#### 💚 CI
+
+See `.gitlab-ci.yml` for the tests that are performed via GitLab CI. You'll need to be a Maintainer to run the tests that interact with Test PyPI (or to release a new package to PyPI).