https://github.com/toolforge/python-toolforge

Mirror of https://gitlab.wikimedia.org/toolforge-repos/python-toolforge
https://github.com/toolforge/python-toolforge

Last synced: 2 months ago
JSON representation

Mirror of https://gitlab.wikimedia.org/toolforge-repos/python-toolforge

• Host: GitHub
• URL: https://github.com/toolforge/python-toolforge
• Owner: toolforge
• License: gpl-3.0
• Created: 2023-04-03T23:07:05.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T16:41:23.000Z (7 months ago)
• Last Synced: 2024-06-24T18:40:18.084Z (7 months ago)
• Language: Python
• Homepage: https://python-toolforge.readthedocs.io/en/latest/
• Size: 92.8 KB
• Stars: 2
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: COPYING

Awesome Lists containing this project

README

        
Toolforge python helper library

===============================

``toolforge`` is a Python library that contains helper functions for some

common tasks that Toolforge_ users might encounter.

Installation

------------

Use ``pip`` to install the latest stable version of ``toolforge``:

.. code-block:: bash

    python3 -m pip install --upgrade toolforge

The current development version is available on gitlab.wikimedia.org_, and can

be installed directly from the git repository:

.. code-block:: bash

    python3 -m pip install --upgrade git+https://gitlab.wikimedia.org/toolforge-repos/python-toolforge.git

Usage

-----

See the `API reference and user guide`_ for usage instructions.

Contributing

------------

See CONTRIBUTING.rst_ for guidelines on contributing to ``toolforge``.

Bug reports

-----------

Please report bugs and feature requests at https://phabricator.wikimedia.org/tag/tool-python-toolforge/.

License

-------

Licensed under the `GPL-3.0-or-later`_ license. See COPYING_ for the full

license.

.. _Toolforge: https://wikitech.wikimedia.org/wiki/Portal:Toolforge

.. _gitlab.wikimedia.org: https://gitlab.wikimedia.org/toolforge-repos/python-toolforge

.. _API reference and user guide: https://python-toolforge.readthedocs.io/

.. _CONTRIBUTING.rst: https://gitlab.wikimedia.org/toolforge-repos/python-toolforge/-/blob/main/CONTRIBUTING.rst

.. _GPL-3.0-or-later: https://www.gnu.org/licenses/gpl-3.0.html

.. _COPYING: https://gitlab.wikimedia.org/toolforge-repos/python-toolforge/-/blob/main/COPYING