beeware.org

This is the homepage for the BeeWare project.

It is a MkDocs-based site.

Getting started

To view a local build of this website, create a virtual environment, and install the development requirements:

$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ python -m pip install --group dev

Then from the root directory of the checkout, run:

(venv) $ tox -e docs-live

This will start a web server that will automatically reload whenever you make a change to site content. This will only build the English version of the site; to build and test the full site, run:

(venv) $ tox -e docs-all,docs-serve

This will also start a web server; however the content will not automatically reload.

Financial support

The BeeWare project would not be possible without the generous support of our financial members:

Anaconda Inc. - Advancing AI through open source.

Plus individual contributions from users like you. If you find Briefcase, or other BeeWare tools useful, please consider becoming a financial member.

Community

You can talk to the community through:

• @beeware@fosstodon.org on Mastodon
• BeeWare Discord server: Discord
• Tickets on the website issue tracker

Code of Conduct

The BeeWare community has a strict Code of Conduct. All users and developers are expected to adhere to this code.

If you have any concerns about this code of conduct, or you wish to report a violation of this code, please contact the project founder Russell Keith-Magee.

Contributing

If you find problems with this website, log them on GitHub. If you want to contribute a modification you can fork this repository and submit a pull request.

Translations

We manage translations using Weblate. Updates to translated content should be submitted through Weblate, not as PRs to this repository.

If you'd like to contribute to the translation effort, join the #translations channel on Discord and introduce yourself!