Installation

Required: Make sure that you have Python 3.10+ installed.

Install the base package:

pip install superduper-framework >= 0.7.0

Install a plugin for your databackend:

# at least one or more of the following:
pip install superduper-mongodb >= 0.7.0
# or
pip install superduper-sql >= 0.7.0
# or
pip install superduper-snowflake >= 0.7.0
# or
pip install superduper-redis >= 0.7.0

Install additional plugins for your use-case (optional):

pip install superduper-<plugin_name>

Check out the documentation

Right here.

Community & getting help

If you have any problems, questions, comments, or ideas:

• Join our Slack (we look forward to seeing you there).
• Search through our GitHub Discussions, or add a new question.
• Comment an existing issue or create a new one.
• Help us to improve Superduper by providing your valuable feedback here!
• Email us at gethelp@superduper.io.
• Visit our YouTube channel.
• Follow us on Twitter (now X).
• Connect with us on LinkedIn.
• Feel free to contact a maintainer or community volunteer directly!

Contributing

There are many ways to contribute, and they are not limited to writing code. We welcome all contributions such as:

• Bug reports
• Documentation improvements
• Enhancement suggestions
• Feature requests
• Expanding the tutorials and use case examples

Please see our Contributing Guide for details.

Contributors

Thanks goes to these wonderful people:

License

Superduper is open-source and intended to be a community effort, and it wouldn't be possible without your support and enthusiasm. It is distributed under the terms of the Apache 2.0 license. Any contribution made to this project will be subject to the same provisions.

Join Us

We are looking for nice people who are invested in the problem we are trying to solve to join us full-time. Find roles that we are trying to fill here!

test change