https://github.com/ionelmc/python-nameless
Sample project. Use https://github.com/ionelmc/cookiecutter-pylibrary to make your own project. The purpose of this repo is to test the CI configuration.
https://github.com/ionelmc/python-nameless
Last synced: 6 months ago
JSON representation
Sample project. Use https://github.com/ionelmc/cookiecutter-pylibrary to make your own project. The purpose of this repo is to test the CI configuration.
- Host: GitHub
- URL: https://github.com/ionelmc/python-nameless
- Owner: ionelmc
- License: bsd-2-clause
- Created: 2014-05-30T17:40:09.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T16:14:28.000Z (over 1 year ago)
- Last Synced: 2024-05-09T08:50:53.779Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 412 KB
- Stars: 145
- Watchers: 5
- Forks: 32
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
========
Overview
========
.. start-badges
.. list-table::
:stub-columns: 1
* - docs
- |docs|
* - tests
- |github-actions| |coveralls| |codecov| |scrutinizer| |codeclimate|
* - package
- |version| |wheel| |supported-versions| |supported-implementations| |commits-since|
.. |docs| image:: https://readthedocs.org/projects/python-nameless/badge/?style=flat
:target: https://readthedocs.org/projects/python-nameless/
:alt: Documentation Status
.. |github-actions| image:: https://github.com/ionelmc/python-nameless/actions/workflows/github-actions.yml/badge.svg
:alt: GitHub Actions Build Status
:target: https://github.com/ionelmc/python-nameless/actions
.. |coveralls| image:: https://coveralls.io/repos/github/ionelmc/python-nameless/badge.svg?branch=main
:alt: Coverage Status
:target: https://coveralls.io/github/ionelmc/python-nameless?branch=main
.. |codecov| image:: https://codecov.io/gh/ionelmc/python-nameless/branch/main/graphs/badge.svg?branch=main
:alt: Coverage Status
:target: https://app.codecov.io/github/ionelmc/python-nameless
.. |codeclimate| image:: https://codeclimate.com/github/ionelmc/python-nameless/badges/gpa.svg
:target: https://codeclimate.com/github/ionelmc/python-nameless
:alt: CodeClimate Quality Status
.. |version| image:: https://img.shields.io/pypi/v/nameless.svg
:alt: PyPI Package latest release
:target: https://pypi.org/project/nameless
.. |wheel| image:: https://img.shields.io/pypi/wheel/nameless.svg
:alt: PyPI Wheel
:target: https://pypi.org/project/nameless
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/nameless.svg
:alt: Supported versions
:target: https://pypi.org/project/nameless
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/nameless.svg
:alt: Supported implementations
:target: https://pypi.org/project/nameless
.. |commits-since| image:: https://img.shields.io/github/commits-since/ionelmc/python-nameless/v1.0.0.svg
:alt: Commits since latest release
:target: https://github.com/ionelmc/python-nameless/compare/v1.0.0...main
.. |scrutinizer| image:: https://img.shields.io/scrutinizer/quality/g/ionelmc/python-nameless/main.svg
:alt: Scrutinizer Status
:target: https://scrutinizer-ci.com/g/ionelmc/python-nameless/
.. end-badges
An example package. Generated with cookiecutter-pylibrary.
* Free software: BSD 2-Clause License
Installation
============
::
pip install nameless
You can also install the in-development version with::
pip install https://github.com/ionelmc/python-nameless/archive/main.zip
Documentation
=============
https://python-nameless.readthedocs.io/
Development
===========
To run all the tests run::
tox
Note, to combine the coverage data from all the tox environments run:
.. list-table::
:widths: 10 90
:stub-columns: 1
- - Windows
- ::
set PYTEST_ADDOPTS=--cov-append
tox
- - Other
- ::
PYTEST_ADDOPTS=--cov-append tox