powrap/README.rst

61 lines
1.7 KiB
ReStructuredText
Raw Normal View History

powrap
2019-12-10 09:09:21 +00:00
======
2017-05-24 20:36:06 +00:00
2023-03-30 21:36:48 +00:00
|pypi| |build|
2019-12-10 09:09:21 +00:00
.. |pypi| image:: https://img.shields.io/pypi/v/powrap.svg
:target: https://pypi.python.org/pypi/powrap
2017-05-24 20:36:06 +00:00
2023-03-30 21:36:48 +00:00
.. |build| image:: https://woodpecker.afpy.org/api/badges/AFPy/powrap/status.svg
:target: https://woodpecker.afpy.org/AFPy/powrap
2017-05-24 20:36:06 +00:00
Script to fix indentation of given ``.po`` files. If ``--modified`` is
2022-04-26 12:43:54 +00:00
given, it will only fix modified files according to git (useful if
your ``.po`` files are versioned).
2017-05-24 20:36:06 +00:00
2019-04-05 11:21:00 +00:00
if ``--quiet`` is given, the progress bar will not be shown
2017-05-24 20:36:06 +00:00
2020-10-14 16:25:19 +00:00
Powrap is part of poutils!
==========================
`Poutils <https://pypi.org/project/poutils>`_ (``.po`` utils) is a metapackage to easily install useful Python tools to use with po files
and ``powrap`` is a part of it! Go check out `Poutils <https://pypi.org/project/poutils>`_ to discover the other tools!
Dependencies
============
``powrap`` relies on ``msgcat`` from ``gettext`` so you'll have to
install ``gettext`` first, for example on Debian run::
apt install gettext
2019-12-10 09:09:21 +00:00
Contributing
============
Start by creating a venv and ``pip install -r requirements-dev.txt`` in
it.
2019-12-10 09:09:21 +00:00
To run the tests, use ``tox -p auto``.
To install ``powrap`` in the current venv run ``pip install -e .``.
Dependencies
------------
We're using ``pip-tools`` to pin our dependencies, but in the
``setup.cfg`` our dependencies are *not* pinned, the goal is to ensure
``powrap`` can easily be installed along with other tools.
Dependencies pinning is only done to have a reproducible development
environment and corresponding env in the CI::
pip-compile setup.py # generates requirements.txt
pip-compile requirements-dev.in # generates requirements-dev.txt
It's possible to upgrade pinned dependencies with the ``--upgrade``
flag of ``pip-compile``.