Pieces of the pygame website (https://www.pygame.org/) will be open sourced here.
Strategy is to bring in code one piece at a time, and clean it up as I go.
It’s a community website where people can post projects, comment on them, but also write things in there themselves on wiki pages.
Please discuss contributions first to avoid disapointment and rework.
The stack is something like: python 3.6, postgresql 9.6, Flask, py.test, sqlalchemy, alembic, gulp, ansible, node.
Set up the required packages:
python3.6 -m venv anenv . ./anenv/bin/activate pip install --upgrade pip pip install -r requirements.dev.txt pip install -e .
For now yuicompressor is needed for css compression:
brew install yuicompressor node optipng apt-get install yui-compressor nodejs optipng
cp example.env .env
See setup.cfg for all tool config (pytest, coverage, etc).
Db setup instructions
One database for testing, and another one for running the app.
We use alembic for db migrations. http://alembic.readthedocs.org/en/latest/
Set up the postgresql database:
createdb pygame psql pygame -c "CREATE USER pygame WITH PASSWORD 'password';" psql pygame -c "GRANT ALL PRIVILEGES ON DATABASE pygame to pygame;"
We also create a database for running tests:
createdb pygame_test psql pygame -c "CREATE USER pygame_test WITH PASSWORD 'password';" psql pygame_test -c "GRANT ALL PRIVILEGES ON DATABASE pygame_test to pygame_test;"
To upgrade to latest model changes do:
alembic upgrade head
When you change a model make an alembic revision:
alembic revision --autogenerate -m "Added a field for these reasons."
Then you will need to apply the change to your db (and commit the version file):
alembic upgrade head
testing with pytest
To run all unit tests and functional tests use:
To watch for changes and rerun tests:
Maybe you just want to test the wiki parts:
pytest -k wiki
tests/unit/ are for unit tests. tests/functional/ are for tests which would use flask and db. tests/conftest.py is for test configuration. tests/sqlpytestflask.py are some fixtures for db testing.
Unit tests and functional tests are kept separate, because functional tests can take a while longer to run.
We use various fixtures to make writing the tests easier and faster.
Running the webserver locally
Use an environment variable to configure the database connection (see the database setup steps above):
Configure a directory containing static files:
The application may need a secure key, but for debugging it’s not important that it’s properly random:
Finally, you can enable some Flask debugging machinery (which should be off for the site in production):
Templates with jinja2 and bootstrap
* `Jinja2 <http://jinja.pocoo.org/>`_ * `Flask-Bootstrap <https://pythonhosted.org/Flask-Bootstrap/basic-usage.html>`_ * `Bootstrap <http://getbootstrap.com/>`_
Command line tools with click
We use click and setuptools entry points (in setup.py) for command line tools:
* `click <http://click.pocoo.org/5/>`_ * `entry points <https://packaging.python.org/distributing/#entry-points>`_
Note, when you add or change a command line tool, you need to pip install -e . again.
If you can, try not to use command line options at all. Have one command do one thing, and make the defaults good, or use the pygameweb.config.
User login with Flask-security-fork
* `flask-security-fork <https://flask-security-fork.readthedocs.io/en/latest/quickstart.html>`_
Dashboard is an overview
of all sorts of things happening in the pygame worlds around the interwebs.
It’s a 7000px wide webpage offering a summary of what’s happening.
Projects people are working on, videos folks are making, tweets twits are… tweeting, questions asked and answered.
To caching things we
With with a @cache decorator, and/or markup in a template.
Step by step release instructions below.
- Commits to master branch do a dev deploy to pypi.
- Commits to mastertest branch do a dev deploy to pypi.
- Commits to a tag do a real deploy to pypi.
Pre releases should be named like this: ` # pygameweb/__init__.py __version__ = '0.0.2' ` Which is one version ahead of of the last tagged release.
Release tags should be like ‘0.0.2’, and match the pygameweb/__init__.py __version__.
Preparing a release in a branch.
It’s a good idea to start a branch first, and make any necessary changes for the release.
` git checkout -b v0.0.2 vi pygameweb/__init__.py __version__ = '0.0.2' git commit -m "Version 0.0.2" `
Change log, drafting a release.
Github ‘releases’ are done as well. You can start drafting the release notes in there before the tag. https://help.github.com/articles/creating-releases/
You can make the release notes with the help of the changes since last release. https://github.com/pygame/pygameweb/compare/0.0.1…master
git log 0.0.1…master
Tagging a release
When the release is tagged, pushing it starts the deploy to pypi off. ` git tag -a 0.0.2 git push origin 0.0.2 ` Note: do not tag pre releases (these are made on commits to master/mastertest).
After the tag is pushed, then you can do the release in github from your draft release.
Back to dev version.
If we were at 0.0.2 before, now we want to be at 0.0.3.dev ` vi pygameweb/__init__.py __version__ = '0.0.3.dev' `
Merge the release branch into master, and push that up.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|pygameweb-0.0.4-py2.py3-none-any.whl (18.7 kB) Copy SHA256 hash SHA256||Wheel||py2.py3||Mar 8, 2018|
|pygameweb-0.0.4.tar.gz (14.1 kB) Copy SHA256 hash SHA256||Source||None||Mar 8, 2018|