Permalink
Browse files

Add extension to "Developers how-to" and README files, updates licens…

…e holders.
  • Loading branch information...
playpauseandstop committed Feb 2, 2014
1 parent 7962da9 commit 8137a00bd00a803db45922c312379a27656c29d4
Showing with 15 additions and 24 deletions.
  1. +12 −22 HOWTO → HOWTO.rst
  2. +1 −1 LICENSE
  3. +2 −1 README → README.rst
View
@@ -1,59 +1,49 @@
==================
Developer’s How To
==================
Tools
-----
=====
Optinal, for testing:
Optional, for testing:
$ pip install pytest pytest-cov
$ pip install -r testapp/requirements.txt
For releasing:
$ pip install tox Sphinx Sphinx-PyPI-upload
$ pip install Sphinx Sphinx-PyPI-upload tox
Running tests
-------------
Either one of:
=============
$ python -m flask_flatpages.tests
$ py.test
$ py.test --cov flask_flatpages --cov-report term-missing
pytest gives debugging help, integration with coverage, etc.
Other testing frameworks should work too.
Just:
$ make -C testapp/ test
Making a new release
--------------------
====================
* Update check MANIFEST.in and package_data in setup.py if non-Python files
were added.
* Update install_requires in setup.py if dependencies changed.
* Check that tests pass in all supported Python versions (2.5, 2.6 and 2.7;
* Check that tests pass in all supported Python versions (2.6, 2.7 and 3.3;
PyPY if you like.) tox can do this automatically, assuming that the
interpreters are installed:
$ tox
* Bump the version number in flask_flatpages/__init__.py
* Bump the version number in flask_flatpages.py
* Update the docs and changelog in docs/index.rst
* Rebuild the docs, check that _build/html/index.html looks good:
$ python setup.py build_sphinx
* Upload the docs to PyPI:
$ python setup.py
* Make and upload the release archive:
$ python setup.py sdist upload upload_sphinx
* Tag the release and push to GitHub:
$ git tag v0.X # Same version number as in flask_flatpages/__init__.py
$ git tag v0.X # Same version number as in flask_flatpages.py
$ git push
$ git push --tags
View
@@ -1,4 +1,4 @@
Copyright (c) 2010 by Simon Sapin.
Copyright (c) 2010-2014 by Simon Sapin, 2013-2014 by Igor Davydenko.
Some rights reserved.
View
@@ -1,5 +1,6 @@
===============
Flask-FlatPages
---------------
===============
Provides flat static pages to a Flask_ application, based on text files
as opposed to a relationnal database.

0 comments on commit 8137a00

Please sign in to comment.