Metadata-Version: 2.1
Name: tabularasa
Version: 0.1.91
Summary: ADD SHORT DESCRIPTION HERE
Home-page: https://github.com/edmundsj/tabularasa
Author: Jordan Edmunds
Author-email: edmundsj@uci.edu
License: MIT
Description: # Template Github Repository
        [![Build](https://github.com/edmundsj/template/actions/workflows/python-package-conda.yml/badge.svg)](https://github.com/edmundsj/template/actions/workflows/python-package-conda.yml) [![docs](https://github.com/edmundsj/template/actions/workflows/build-docs.yml/badge.svg)](https://github.com/edmundsj/template/actions/workflows/build-docs.yml )[![codecov](https://codecov.io/gh/edmundsj/template/branch/main/graph/badge.svg?token=7L4PK4K0P3)](https://codecov.io/gh/edmundsj/template)
        
        This is a template repository for python projects which use sphinx for
        documentation, github actions for building, pytest and codecov for test
        coverage.
        
        
        ## Getting Started
        0. Choose a name for the new repository. Make sure it's available as a name on [testPyPi](https://test.pypi.org/)
          and [PyPi](https://pypi.org/). Create a new directory with that chosen module name.
        
        1. Create a new repository on github with your chosen module name.
        
        2. Add this repositry to codecov: https://app.codecov.io/gh/edmundsj, and add the CODECOV_TOKEN secret to the github repository. You may need to login to codecov to refresh the repositories.
        
        3. Create a new authentication token on testPyPi and add it as a github secret named ``test_pypi_password``\*
        
        4. Create a new authentication token on PyPi and add it as a github secret named ``pypi_password``\*
        
        5. Clone this repository into your new directory
        
            ```git clone https://github.com/edmundsj/template.git <MODULE_NAME>```
        
        6. Navigate into the cloned repository, and run the setup script. This will change all the names in the relevant setup files, using:
        
            ```python repo_setup.py```
        
        If this does not work, you will need to do the following manually:
        
        6a. Change the git hooks location:
        
            ```git config core.hooksPath .hooks```
        6b. Change this repository's name with 
        
           ```git remote set-url origin <NEW_REPO_URL>```
        6c. In the ``setup.py``, ``.hooks/pre-commit``, and ``.github/workflows/python-package-conda`` files, change all instances of "pytemplate" to "MODULE_NAME". 
        
        6d. Push to the new repository 
        
            ```git push -u origin main```
        
        7. Set github pages to use the ``docs/`` folder for github pages at the bottom of the "Settings" page
        8. Create a status badge from the '... -> Create Status Badge' in the github actions area separately for docs and build, and paste them in the README, as well as from codecov.
        9. If desired, once the build on the remote server finishes, replace the tokens from testPyPi and pyPi with ones that are restricted to this pyPi project.
        
        
        Done! Your repository should be viewable on github pages: 
        https://edmundsj.github.io/REPO_NAME/
        
        * Note - since the package does not already exist on pyPi or testPyPi you will need to create a token that has access to all your projects. This obviously isn't an optimal way of doing things, and this should really be changed. I may want to add a setup script which does all the renaming, changes github hooks, and does an initial deploy to pypi and testpypi. If you want after the first push, you can create a new token restricted to the newly-pushed project.
        
        ## Features
        
        - Github actions unit test integration via pytest
        - Github actions package management with conda
        - Github actions documentation build using sphinx and reST/markdown, with auto
        self-push to repository after successful build
        - Github pages documentation hosting/integration
        - Local commits hooks run full test suite
        - Coverage uploaded automatically to codecov after successful build
        - [FUTURE] Auto-deploy to pyPi/testpyPi after successful build
        
        ## Common Issues
        - Re-running builds on github actions will cause them to fail, as the build number deployed to PyPi depends on the github run number, which does not change if you restart a build.
        - Pypi deploy is failing due to swap files. not sure why.
        
        ## How to Use
        ### Adding Additional Unit Tests
        - Any time you want to add additional unit tests just add them to those in the
        ``tests/`` directory and prepend with the name ``test``. These will be
        automatically found by pytest and run during local commits and remote builds.
        
        ### Writing the Documentation
        - The documentation source is located in ``docs/source`` and is written in
        restructured text (markdown is also available).
        
        ### Building the Documentation
        Simply run ``make html`` from the ``docs/`` directory. This will compile the
        files in the ``docs/source/`` directory, and place them in the main ``docs/``
        directory where github pages can find them.
        
        ## Dependencies / Technologies Used
        - [Sphinx](http://www.sphinx-doc.org/)
        - [pytest](https://docs.pytest.org/en/stable/index.html)
        - [Github Actions](https://github.com/features/actions)
        - [Codecov](https://codecov.io/)
        - [Github Pages](https://pages.github.com/)
        
        ## Acknowledgements
        Thanks to all the great people on stack overflow and github, for their
        seemingly boundless tolerance to my and others' questions. 
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
