https://github.com/unfoldingword-dev/uw_tools

https://github.com/unfoldingword-dev/uw_tools

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/unfoldingword-dev/uw_tools
• Owner: unfoldingWord-dev
• License: other
• Created: 2016-05-10T19:46:56.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-06-04T01:18:15.000Z (about 8 years ago)
• Last Synced: 2025-02-20T00:31:26.506Z (over 1 year ago)
• Language: Python
• Size: 2.13 MB
• Stars: 0
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
master:

.. image:: https://travis-ci.org/unfoldingWord-dev/uw_tools.svg?branch=master

    :alt: Build Status

    :target: https://travis-ci.org/unfoldingWord-dev/uw_tools

.. image:: https://coveralls.io/repos/github/unfoldingWord-dev/uw_tools/badge.svg?branch=master

    :alt: Build Status

    :target: https://coveralls.io/github/unfoldingWord-dev/uw_tools

develop:

.. image:: https://travis-ci.org/unfoldingWord-dev/uw_tools.svg?branch=develop

    :alt: Build Status

    :target: https://travis-ci.org/unfoldingWord-dev/uw_tools

.. image:: https://coveralls.io/repos/github/unfoldingWord-dev/uw_tools/badge.svg?branch=develop

    :alt: Build Status

    :target: https://coveralls.io/github/unfoldingWord-dev/uw_tools

unfoldingWord Python Tools

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

A collection of Python scripts that have proven useful and have been reused.

As the files are moved from their original location into this project, we are trying to make sure they are compatible

with both Python 2.7 and 3.5.

**To use this library, install it in your Python environment like this:**

::

    pip install uw-tools

**To install a particular version (tag, branch or commit) use this:**

::

    pip install git+git://github.com/unfoldingWord-dev/uw_tools.git@Tag-Branch-or-Commit#egg=uw-tools

Submitting to pypi

******************

**Add the library to pypi if you haven't already.**

1. Run ``python setup.py sdist bdist_wheel``.

2. Go to https://pypi.python.org/pypi?%3Aaction=submit_form

3. Click "Choose File" and pick ``uw_tools.egg-info/PKG-INFO``, then click "Add Package Info."

**Install twine**

::

    sudo pip install twine

**Create settings file ``~/.pypirc`` with these contents:**

::

    [distutils]

    index-servers=pypi

    [pypi]

    repository = https://upload.pypi.org/legacy/

    username = 

    password = 

**Generate the packages and upload**

::

    python setup.py sdist bdist_wheel

    twine upload dist/*