Skip to main content

describe your project

Project description

Backup API
==========

|PyPI| |image1| |image2| |GitHub release| |PyPI| |license| |PRs Welcome|

Very short description about your project.

**Early Development**

Please note that this project is in planning/early development
phase! Many things might not work or not even exist the way you
would expect.

Getting Started
---------------

These instructions will get you a copy of the project up and running on
your local machine for development and testing purposes. See deployment
for notes on how to deploy the project on a live system.

Prerequisites
~~~~~~~~~~~~~

Mention any requirements the user should check and install before using
your software.

- Python 2.7 or 3.5
- tested on Windows 7 and 10
- should work on macOS and Linux

Installing
~~~~~~~~~~

::

pip install ProjectSetup

If this doesn’t work, try to download the code, extract the zip-file and
run:

::

python setup.py install

Running the tests
-----------------

If you like to run the tests, just open a terminal in the project
directory and run:

::

python -m unittest discover -s test -p "*_test.py"

Built With
----------

- `Flask <http://flask.pocoo.org/>`__ - is a microframework for Python
based on Werkzeug, Jinja 2 and good intentions
- `PySide <https://pypi.python.org/pypi/PySide/1.2.4>`__ - pythonic Qt
bridge

Contributing
------------

First of all: Thank you very kindly for your interest in contributing to
our code!

Please take a moment and read `CONTRIBUTING.md <Contributing.md>`__ to
get you started!

Versioning
----------

We use `SemVer <http://semver.org/>`__ for versioning. For the versions
available, see the `releases on this
repository <https://github.com/michagrandel/ProjectSetup/releases>`__.

Authors
-------

- **Micha Grandel** - *Author and maintainer* -
`Github <https://github.com/michagrandel>`__

We thank all of our
`contributors <https://github.com/michagrandel/ProjectSetup/graphs/contributors>`__,
who participated in this project.

License
-------

This project is licensed under the Apache 2.0 License - see the
`LICENSE <LICENSE>`__ file for details

.. |PyPI| image:: https://img.shields.io/pypi/pyversions/ProjectSetup.svg
:target: http://pypi.python.org
.. |image1| image:: https://img.shields.io/travis/michagrandel/ProjectSetup/develop.svg
:target: https://travis-ci.org/michagrandel/BackupApi
.. |image2| image:: https://img.shields.io/codecov/c/github/michagrandel/ProjectSetup/develop.svg
:target:
.. |GitHub release| image:: https://img.shields.io/github/release/michagrandel/ProjectSetup.svg
:target: https://github.com/michagrandel/releases
.. |PyPI| image:: https://img.shields.io/pypi/v/ProjectSetup.svg
:target: http://pypi.python.org
.. |license| image:: https://img.shields.io/github/license/michagrandel/ProjectSetup.svg
:target: https://github.com/michagrandel/ProjectSetup/blob/master/LICENSE
.. |PRs Welcome| image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
:target: http://makeapullrequest.com


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ProjectSetup-0.1.0.tar.gz (12.6 kB view hashes)

Uploaded Source

Built Distribution

ProjectSetup-0.1.0-py2.py3-none-any.whl (13.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page