Skip to content

Commit

Permalink
Add a few step to start hack on the project in development section RE…
Browse files Browse the repository at this point in the history
…ADME
  • Loading branch information
laxathom authored and cverna committed Aug 12, 2019
1 parent 7c5db2d commit 56a289d
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 5 deletions.
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,15 @@ pip-log.txt
.tox
coverage.xml

#Translations
# Translations
*.mo

#Mr Developer
# Mr Developer
.mr.developer.cfg

# swap etc
*.swp
*.swo

## PyCharm
.idea/
45 changes: 43 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,50 @@ This is an example of awarding a badge via Tahrir-API:
Development
===========

Set-up your env
---------------
Install helper

.. code-block:: bash
$ sudo dnf install -y python3-virtualenvwrapper # RedHat-based OS
Build your virtual env

.. code-block:: bash
$ export WORKON_HOME=$HOME/.virtualenvs
$ mkvirtualenv tahrir-api
Connect w/ your virutal env

.. code-block:: bash
$ workon tahrir-api
(tahrir-api)$
Install
-------
Requirements

.. code-block:: bash
(tahrir-api)$ pip install -r requirements.txt
Project installation

.. code-block:: bash
(tahrir-api)$ python setup.py develop
Happy hacking!

Run the tests
-------------

You can run the tests with ``tox``::
You can run the tests with ``tox``

.. code-block:: bash
$ tox
(tahrir-api)$ pip install tox
(tahrir-api)$ tox
2 changes: 1 addition & 1 deletion alembic.ini
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ script_location = alembic
# revision_environment = false

# I guess we'll just assume that tahrir is in the same parent directory?
sqlalchemy.url = sqlite:///%(here)s/../tahrir/tahrir.db
sqlalchemy.url = sqlite:////%(here)s/tahrir.db


# Logging configuration
Expand Down

0 comments on commit 56a289d

Please sign in to comment.