Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ndjenkins85/test_ndj_cookie


https://github.com/ndjenkins85/test_ndj_cookie

Last synced: 10 days ago
JSON representation

Awesome Lists containing this project

README 

        
# My test Project



What is it, at a high high level?

Who is the audience or end users? Any requirements?

What are the feature and benefits?



* [Instructions for users](#instructions-for-users)

* [Instructions for developers](#instructions-for-developers)

  * [Dependency and virtual environment management, library development and build with poetry](#dependency-and-virtual-environment-management-library-development-and-build-with-poetry)

  * [Dependency and virtual environment management, library development and build with conda](#dependency-and-virtual-environment-management-library-development-and-build-with-conda)

  * [Code quality, testing, and generating documentation with Nox](#code-quality-testing-and-generating-documentation-with-nox)

  * [Code formatting with Pre-commit](#code-formatting-with-pre-commit)

* [Contributors](#contributors)



## Instructions for users



The following are the quick start instructions for using the project as an end-user.

[Instructions for developers](#instructions-for-developers) follows this section.



Installation (Note, not actually functioning):



```bash

pip install my_project

```



Include an example of running the program with expected outputs.



```bash

python -m my_project.utils -i1 environment.yml -i2 environment.yml -v

...

2021-08-29 14:59:09,489 [DEBUG] Loading main file from environment.yml

2021-08-29 14:59:09,489 [DEBUG] Loading second file from environment.yml

...

  - pytest-cov=2.10.1

  - python=^3.8

  - sphinx=3.2.1

  - sphinx-autodoc-typehints=1.12.0

  - sphinx_rtd_theme=0.4.3

```



Can also be run as a script.



```bash

my_project -i1 environment.yml -i2 environment.yml -v

```



## Instructions for developers



The following are the setup instructions for developers looking to improve this project.

For information on current contributors and guidelines see the [contributors](#contributors) section.

Follow each step here and ensure tests are working.



### Dependency and virtual environment management, library development and build with poetry



Ensure you have and installation of Poetry 1.2.0a1 or above, along with poetry-version-plugin.



Make sure you deactivate any existing virtual environments (i.e. conda).



```bash

poetry install

```



You may need to point poetry to the correct python interpreter using the following command.

In another terminal and in conda, run `which python`.

```bash

poetry env use /path/to/python3

```



Library can be built using



```bash

poetry build

```



### Dependency and virtual environment management, library development and build with conda



Following commands will create the conda environment and setup the library in interactive development mode using setup.py.



```bash

conda env create -f environment.yml

conda activate my_project

pip install -e .

```



Library can be built using



```bash

python setup.py bdist_wheel

```



### Code quality, testing, and generating documentation with Nox



Nox is a python task automation tool similar to Tox, Makefiles or scripts.



The following command can be used to run mypy, lint, and tests.

It is recommended to run these before pushing code, as this is run with Github Actions.

Some checks such as black are run more frequently with [pre-commit](#installing-pre-commit).



```bash

poetry run nox

```



Local Sphinx documentation can be generated with the following command.

Documentation publishing using Github Actions to Github pages is enabled by default.



```bash

poetry run nox -s docs

```



All other task automations commands can be optionally run locally with below command.



```bash

poetry run nox -s black safety pytype typeguard coverage xdoctest autoflake

```



### Code formatting with Pre-commit



On first time use of the repository, pre-commit will need to be installed locally.

You can use the following command to install and run pre-commit over all files.

See .pre-commit-config.yaml for checks in use.

Intention is to have lightweight checks that automatically make code changes.



``` bash

pre-commit run --all-files

```



## Contributors



* [Nick Jenkins](https://www.nickjenkins.com.au) - Data Scientist, API & Web dev, Team lead, Writer



See [CONTRIBUTING.md](CONTRIBUTING.md) for specific instructions on contributing to project.



Usage rights governed by [LICENSE](LICENSE).