https://github.com/smarie/python-doit-api

`pydoit` for humans: an API to create `doit` tasks faster and more reliably.
https://github.com/smarie/python-doit-api

api autocomplete decorator doit easy fast friendly generator human object pydoit task

Last synced: about 1 year ago
JSON representation

`pydoit` for humans: an API to create `doit` tasks faster and more reliably.

• Host: GitHub
• URL: https://github.com/smarie/python-doit-api
• Owner: smarie
• License: bsd-3-clause
• Created: 2020-09-10T12:24:48.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-10-09T20:13:17.000Z (over 5 years ago)
• Last Synced: 2024-04-20T10:21:31.620Z (about 2 years ago)
• Topics: api, autocomplete, decorator, doit, easy, fast, friendly, generator, human, object, pydoit, task
• Language: Python
• Homepage: https://smarie.github.io/python-doit-api/
• Size: 1.06 MB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# doit-api

*`pydoit` for humans: an API to create `doit` tasks faster and more reliably.*

[![Python versions](https://img.shields.io/pypi/pyversions/doit-api.svg)](https://pypi.python.org/pypi/doit-api/) [![Build Status](https://travis-ci.org/smarie/python-doit-api.svg?branch=master)](https://travis-ci.org/smarie/python-doit-api) [![Tests Status](https://smarie.github.io/python-doit-api/junit/junit-badge.svg?dummy=8484744)](https://smarie.github.io/python-doit-api/junit/report.html) [![codecov](https://codecov.io/gh/smarie/python-doit-api/branch/master/graph/badge.svg)](https://codecov.io/gh/smarie/python-doit-api)

[![Documentation](https://img.shields.io/badge/doc-latest-blue.svg)](https://smarie.github.io/python-doit-api/) [![PyPI](https://img.shields.io/pypi/v/doit-api.svg)](https://pypi.python.org/pypi/doit-api/) [![Downloads](https://pepy.tech/badge/doit-api)](https://pepy.tech/project/doit-api) [![Downloads per week](https://pepy.tech/badge/doit-api/week)](https://pepy.tech/project/doit-api) [![GitHub stars](https://img.shields.io/github/stars/smarie/python-doit-api.svg)](https://github.com/smarie/python-doit-api/stargazers)

**This is the readme for developers.** The documentation for users is available here: [https://smarie.github.io/python-doit-api/](https://smarie.github.io/python-doit-api/)

## Want to contribute ?

Contributions are welcome ! Simply fork this project on github, commit your contributions, and create pull requests.

Here is a non-exhaustive list of interesting open topics: [https://github.com/smarie/python-doit-api/issues](https://github.com/smarie/python-doit-api/issues)

## Running the tests

This project uses `pytest`.

```bash

pytest

```

## Packaging

This project uses `setuptools_scm` to synchronise the version number. Therefore the following command should be used for development snapshots as well as official releases: 

```bash

python setup.py egg_info bdist_wheel rotate -m.whl -k3

```

## Generating the documentation page

This project uses `mkdocs` to generate its documentation page. Therefore building a local copy of the doc page may be done using:

```bash

mkdocs build -f docs/mkdocs.yml

```

## Generating the test reports

The following commands generate the html test report and the associated badge. 

```bash

pytest --junitxml=junit.xml -v doit_api/tests/

ant -f ci_tools/generate-junit-html.xml

python ci_tools/generate-junit-badge.py

```

### PyPI Releasing memo

This project is now automatically deployed to PyPI when a tag is created. Anyway, for manual deployment we can use:

```bash

twine upload dist/* -r pypitest

twine upload dist/*

```