Contribute

Here are all the ways you can contribute to this project.

Testing

The best way to help is by using the package, either on the command line or as a module, suggesting improvements and reporting bugs. You’re very welcome to open an issue.

Hacking

If you have Python skills, contribute to the code.

These are the prerequisites:

  • Python 3.10+

  • Poetry

Install from the source, following the From source instructions.

Brief explanation about the code under the Wayback Tweets directory:

  • app: Streamlit application code

  • assets: Title and logo images

  • docs: Documentation generated with Sphinx

  • legacy_app: Legacy Streamlit application code

  • waybacktweets/api: Main package modules

  • waybacktweets/config: Global configuration module

  • waybacktweets/exceptions: Wayback Tweets Exceptions

  • waybacktweets/utils: Helper functions used in the package

Sponsoring

You can also donate to the project’s developer and maintainer, Claromes, via GitHub Sponsor or if you are interested in sponsoring the project you can contact via email at support at claromes dot com.