Browse Source

Update links (e.g. pypi.org), rename py.test command

pull/341/head
Simon Conseil 8 years ago
parent
commit
315bb800b7
  1. 5
      Makefile
  2. 5
      README.rst
  3. 2
      docs/changelog.rst
  4. 4
      docs/contribute.rst
  5. 4
      sigal/plugins/compress_assets.py
  6. 2
      sigal/plugins/feeds.py
  7. 2
      sigal/plugins/upload_s3.py
  8. 2
      tox.ini

5
Makefile

@ -1,15 +1,16 @@
init:
pip install -e .
pip install -r requirements.txt
docs:
make -C docs html
test:
py.test
pytest
coverage:
py.test --cov sigal --cov-report term --cov-report=html
pytest --cov sigal --cov-report term --cov-report=html
demo:
sigal build -c tests/sample/sigal.conf.py && sigal serve tests/sample/_build

5
README.rst

@ -13,7 +13,7 @@ Sigal is yet another simple static gallery generator. It's written in Python
and it allows to build a static gallery of images with the following features:
* Process directories recursively.
* Generate HTML pages using jinja2 templates.
* Generate HTML pages using Jinja2_ templates.
* Relative links for a portable output.
* Support themes, videos, EXIF tags, zip download.
* Parallel processing.
@ -45,7 +45,7 @@ Javascript libraries:
.. _website: http://sigal.saimon.org/
.. _GitHub: https://github.com/saimn/sigal/
.. _PyPI: http://pypi.python.org/pypi/sigal
.. _PyPI: https://pypi.org/project/sigal/
.. _galleria: http://galleria.io/
.. _colorbox: http://www.jacklmoore.com/colorbox
.. _photoswipe: http://photoswipe.com
@ -55,3 +55,4 @@ Javascript libraries:
.. _webchat: http://webchat.freenode.net/?channels=sigal
.. _Archives: http://librelist.com/browser/sigal/
.. _Mailing list: mailto:sigal@librelist.com
.. _Jinja2: http://jinja.pocoo.org/

2
docs/changelog.rst

@ -323,7 +323,7 @@ Version 0.3.2
Released on 2013-03-14.
- Bugfix for PNG files which don't have exif metadata.
- Move unit tests to py.test.
- Move unit tests to pytest.
- Fix images path in colorbox theme.
- Group package meta in a module.

4
docs/contribute.rst

@ -30,9 +30,9 @@ Building the docs
Running the test suite
----------------------
- Run ``make test`` (or ``py.test``).
- Run ``make test`` (or ``pytest``).
- Run ``make coverage`` to get the coverage report.
- Using tox_ you can also run the tests on multiple versions of python.
.. _tox: https://testrun.org/tox/
.. _tox: https://tox.readthedocs.io/
.. _virtualenv: https://virtualenv.pypa.io/

4
sigal/plugins/compress_assets.py

@ -16,8 +16,8 @@ Currently, 3 methods are supported:
- ``brotli``: Requires brotli_.
Brotli is the best compressor for web usage.
.. _zopfli: https://pypi.python.org/pypi/zopfli
.. _brotli: https://pypi.python.org/pypi/Brotli
.. _zopfli: https://pypi.org/project/zopfli/
.. _brotli: https://pypi.org/project/Brotli/
Settings available as dictionary in ``compress_assets_options``:

2
sigal/plugins/feeds.py

@ -3,7 +3,7 @@
This plugin requires feedgenerator_. It uses all the images and videos of the
gallery, sorted by date, to show the most recent ones.
.. _feedgenerator: https://pypi.python.org/pypi/feedgenerator
.. _feedgenerator: https://pypi.org/project/feedgenerator/
Settings:

2
sigal/plugins/upload_s3.py

@ -6,7 +6,7 @@ exists and the you have access to the S3 bucket. The access credentials are
managed by boto_ and can be given as environment variables, configuration files
etc. More information can be found on the boto_ documentation.
.. _boto: https://pypi.python.org/pypi/boto
.. _boto: https://pypi.org/project/boto/
Settings (all settings are wrapped in ``upload_s3_options`` dict):

2
tox.ini

@ -3,7 +3,7 @@ envlist = py{35,36},report,check
skip_missing_interpreters = True
[testenv]
commands = py.test --cov sigal --cov-report term-missing
commands = pytest --cov sigal --cov-report term-missing
deps =
pytest
pytest-cov

Loading…
Cancel
Save