https://github.com/andy-maier/cookiecutter-python-package

The package content used by cookiecutter-python, for easier sync with other repos. Don't use this directly but through cookiecutter-python.
https://github.com/andy-maier/cookiecutter-python-package

Last synced: 26 days ago
JSON representation

The package content used by cookiecutter-python, for easier sync with other repos. Don't use this directly but through cookiecutter-python.

• Host: GitHub
• URL: https://github.com/andy-maier/cookiecutter-python-package
• Owner: andy-maier
• License: apache-2.0
• Created: 2021-01-27T06:36:19.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T06:24:08.000Z (over 1 year ago)
• Last Synced: 2023-05-01T07:37:33.405Z (over 1 year ago)
• Language: Makefile
• Homepage: https://github.com/andy-maier/cookiecutter-python
• Size: 144 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
{{ cookiecutter.project_name }} - {{ cookiecutter.short_description }}

===============================

.. image:: https://badge.fury.io/py/{{ cookiecutter.package_name }}.svg

    :target: https://pypi.python.org/pypi/{{ cookiecutter.package_name }}/

    :alt: Version on Pypi

.. image:: https://github.com/{{ cookiecutter.github_org }}/{{ cookiecutter.github_repo }}/workflows/test/badge.svg?branch=master

    :target: https://github.com/{{ cookiecutter.github_org }}/{{ cookiecutter.github_repo }}/actions/

    :alt: Actions status

.. image:: https://readthedocs.org/projects/{{ cookiecutter.package_name }}/badge/?version=latest

    :target: https://readthedocs.org/projects/{{ cookiecutter.package_name }}/builds/

    :alt: Docs build status (master)

.. image:: https://coveralls.io/repos/github/{{ cookiecutter.github_org }}/{{ cookiecutter.github_repo }}/badge.svg?branch=master

    :target: https://coveralls.io/github/{{ cookiecutter.github_org }}/{{ cookiecutter.github_repo }}?branch=master

    :alt: Test coverage (master)

Overview

--------

TBD

Installation

------------

To install the latest released version of the {{ cookiecutter.package_name }}

package into your active Python environment:

.. code-block:: bash

    $ pip install {{ cookiecutter.package_name }}

This will also install any prerequisite Python packages.

For more details and alternative ways to install, see

`Installation`_.

.. _Installation: https://{{ cookiecutter.package_name }}.readthedocs.io/en/stable/intro.html#installation

Documentation

-------------

* `Documentation for latest released version `_

Change History

--------------

* `Change history for latest released version `_

Quick Start

-----------

The following simple example script lists the namespaces and the Interop

namespace in a particular WBEM server:

.. code-block:: python

    #!/usr/bin/env python

    import {{ cookiecutter.package_name }}

    ... (tbd) ...

Contributing

------------

For information on how to contribute to the

{{ cookiecutter.project_name }} project, see

`Contributing `_.

License

-------

The {{ cookiecutter.project_name }} project is provided under the

`{{ cookiecutter.open_source_license }} `_.