XComment 0.0.2

Setting Things Up on Ubuntu

1. Enter the shell.

2. Install pyenv via [pyenv-installer](https://github.com/pyenv/pyenv-installer):

   $ curl -L https://raw.githubusercontent.com/pyenv/pyenv-installer/master/bin/pyenv-installer | bash

   

3. Follow the instructions on how to initialize pyenv on shell startup, for instance:

   $ echo 'export PATH="/root/.pyenv/bin:$PATH"' >> ~/.bash_profile
   $ echo 'eval "$(pyenv init -)"' >> ~/.bash_profile
   $ echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bash_profile

   

4. Install Python 3.6.x via pyenv, say Python 3.6.2 (latest micro release versions are preferred):

   $ pyenv install 3.6.2

   

5. Create a virtualenv for the project:

   $ pyenv virtualenv 3.6.2 comments_remover

   

6. Switch to whatever directory you wish the project to reside in, say ~:

   $ cd ~

   

7. Clone the project from GitHub:

   • either via SSH (the preferred way):

   $ git clone git@github.com:Singapore-Tech-Entrepreneurs/comments_remover.git

   

   • or via HTTPS:

   $ git clone https://github.com/Singapore-Tech-Entrepreneurs/comments_remover.git

   

8. Switch to the project directory:

   $ cd comments_remover

   

9. Activate the virtualenv:

   $ pyenv activate comments_remover

   

10. Install project dependencies:

    $ pip install -U -r ./requirements.txt

    

11. Install dependencies for testing:

    $ pip install -U -r ./requirements-test.txt

    

12. (optional) Install [IPython](https://ipython.org/) interactive shell to speed up development:

    $ pip install ipython==6.1.0

    

To run tests, simply

$ pytest ./

To also see coverage report,

pytest --cov ./

You should be good to go now.

Install dependencies

$ python install -r requirements-deploy.txt

Set pypi credentials

$ export TWINE_USERNAME=<pypi username>
$ export TWINE_PASSWORD=<pypi password>

Create distribution

$ python setup.py sdist bdist_wheel

Upload

$ twine upload dist/XComment-x.y.z.tar.gz