arroba 0.1

Python implementation of Bluesky's low level AT Protocol, including repo, MST, and sync methods

arroba

Python implementation of Bluesky's low level AT Protocol, including data repository, Merkle search tree, and com.atproto.sync XRPC methods.

Arroba is the Spanish word for the @ character ("at sign").

Install from PyPI with pip install arroba.

License: This project is placed into the public domain.

• Usage
• Changelog
• Release instructions

Usage

TODO

Changelog

0.1 - 2023-04-30

Initial release! Still very in progress. MST, Walker, and Diff classes are mostly complete and working. Repo, commits, and sync XRPC methods are still in progress.

Release instructions

Here's how to package, test, and ship a new release.

1. Run the unit tests.

   source local/bin/activate.csh
   python3 -m unittest discover
   

2. Bump the version number in pyproject.toml and docs/conf.py. git grep the old version number to make sure it only appears in the changelog. Change the current changelog entry in README.md for this new version from unreleased to the current date.

3. Build the docs. If you added any new modules, add them to the appropriate file(s) in docs/source/. Then run ./docs/build.sh. Check that the generated HTML looks fine by opening docs/_build/html/index.html and looking around.

4. git commit -am 'release vX.Y'

5. Upload to test.pypi.org for testing.

   python3 -m build
   setenv ver X.Y
   twine upload -r pypitest dist/arroba-$ver*
   

6. Install from test.pypi.org.

   cd /tmp
   python3 -m venv local
   source local/bin/activate.csh
   pip3 uninstall arroba # make sure we force pip to use the uploaded version
   pip3 install --upgrade pip
   pip3 install -i https://test.pypi.org/simple --extra-index-url https://pypi.org/simple arroba==$ver
   deactivate
   

7. Smoke test that the code trivially loads and runs.

   source local/bin/activate.csh
   python3
   # TODO: test code
   deactivate
   

8. Tag the release in git. In the tag message editor, delete the generated comments at bottom, leave the first line blank (to omit the release "title" in github), put ### Notable changes on the second line, then copy and paste this version's changelog contents below it.

   git tag -a v$ver --cleanup=verbatim
   git push && git push --tags
   

9. Click here to draft a new release on GitHub. Enter vX.Y in the Tag version box. Leave Release title empty. Copy ### Notable changes and the changelog contents into the description text box.

10. Upload to pypi.org!

    twine upload dist/arroba-$ver.tar.gz dist/arroba-$ver-py3-none-any.whl
    

11. Wait for the docs to build on Read the Docs, then check that they look ok.

12. On the Versions page, check that the new version is active, If it's not, activate it in the Activate a Version section.