Metadata-Version: 2.1
Name: tdsr
Version: 0.0.2
Summary: tdsr
Home-page: https://github.com/torstendahm/tdsr
Author: torstendahm
Author-email: contact@romnn.com
License: GPLv3
Keywords: tdsr
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.6
Provides-Extra: dev
Provides-Extra: test
License-File: LICENSE
License-File: AUTHORS.rst

===============================
tdsr
===============================

.. image:: https://github.com/torstendahm/tdsr/workflows/test/badge.svg
        :target: https://github.com/torstendahm/tdsr/actions
        :alt: Build Status

.. image:: https://img.shields.io/pypi/v/tdsr.svg
        :target: https://pypi.python.org/pypi/tdsr
        :alt: PyPI version

.. image:: https://img.shields.io/github/license/torstendahm/tdsr
        :target: https://github.com/torstendahm/tdsr
        :alt: License

.. image:: https://img.shields.io/badge/docs-tdsr-green
        :target: https://torstendahm.github.io/tdsr
        :alt: Documentation

""""""""

Your short description here. 

.. code-block:: console

    $ pip install tdsr

Usage
-----

Usage instructions t.b.a.

.. code-block:: python

    import tdsr


Development
-----------

If you want to contribute to ``tdsr``, we highly recommend setting up a virtual environment for local development. You can easily do so with ``pipenv``, which can be installed with ``pip install --user pipenv`` (`instructions <https://pipenv.pypa.io/en/latest/install/>`_) by following the steps below. Note that all commands should be run in the top level directory of the cloned ``tdsr`` repository.

.. code-block:: bash

    $ git clone https://github.com/torstendahm/tdsr.git
    $ cd tdsr
    $ pipenv install --dev

With the virtual environment set up, activate it with ``pipenv shell``. To exit the virtual environment, run ``exit``.

invoke, linting, formatting, code checks t.b.a
