Skip to content

Latest commit

 

History

History
111 lines (71 loc) · 3.66 KB

developer-guide.md

File metadata and controls

111 lines (71 loc) · 3.66 KB
Raw

Developer guide

Table of content

Install requirements

pip install -r requirements-dev.txt
pip install -r requirements.txt

Linux/macOS

Install line-profiler for Linux or macOS environments:

pip install -r requirements-nix-dev.txt

Windows

Install line-profiler for Windows depending on the Python version:

# Python 3.7
python -m pip install line-profiler@https://download.lfd.uci.edu/pythonlibs/x2tqcw5k/line_profiler-3.0.2-cp37-cp37m-win_amd64.whl

# Python 3.8
python -m pip install line-profiler@https://download.lfd.uci.edu/pythonlibs/x2tqcw5k/line_profiler-3.0.2-cp38-cp38-win_amd64.whl

Install nlp-profiler

Do the below to start getting ready to work in the developer mode.

git clone https://github.com/neomatrix369/nlp_profiler
cd nlp_profiler
python setup.py install

or

pip install -e .

or

pip install --prefix .

Tests

Run all the tests with coverage information using the below command after all packages have been successfully installed:

./test-coverage.sh tests slow-tests

On the tests passing (or partially passing), these folders will be created:

.coverage-reports
.cprofile
.test-run-reports

Also files with the name .coverage* will be created. The shell script will give enough guidance to be able to know where to find the respective reports.

Notebooks

In order to know how to change notebooks, see How to update the notebooks? section in the Notebooks docs.

CI/CD

We are using GitHub actions to enable this feature. See .github/workflows to find out about the different actions configured to achieve this. See GitHub Actions docs for further help.

At the moment we have only implemented the CI part of CI/CD. This is work in progress as of the writing of this doc. Deploying to PyPi is done manually.

Contribution steps

Do these in the sequential order:

  • In addition to have read the Contribution guide, please also follow the steps in the Table of Contents above.

  • Creating a Pull request will also result in these steps to be executed on Windows and Linux instances via the GitHub action(s) (this also covers for macOS environments as it is equivalent to the Linux environment to a good extend).

  • Also the Pull Request description body will be populated with the contents of this Pull Request template, please also follow through the step mentioned in the template.

  • Any failures on the PR would need to be addressed. More details on specific changes will be addressed at a later time, but the failures in tests or at any other aspect should more or less indicate the reason for failure. If not, please look for past reported issues under GitHub issues or report a new one with the specifics of the issue in hand.

  • Check if all the notebooks in the repo reflect your changes, if not please regenerate them and make them part of the pull request.

  • Additional to help the process please also feel free to the amend/improve the GitHub actions under .github/workflows.

Return to Developer guide section in the README.md
Return to README.md