samreay / workshopexample

A small github repo used as an example for the coding workshop

WorkshopExample

A small github repo used as an example for the coding workshop!

Access the online doco here!

---

To use this framework you will need to:

1. Replace my email ([email protected]) with your own.
2. Replace all instances of samreay & samuelreay, with your own username (case insensitive replace).
3. Replace my name (Samuel Hinton) with yours (used in the doc and license).
4. Update the project name if you rename it. (At this point, should have edits to .travis.yml, setup.py, README.md, conf.py, LICENSE.)
5. Enable Travis, CodeCov and Codacy. (You may need to make a commit and push after enabling travis to kick off a build.)
6. Update the codacy badge in this readme because it uses more than username/repo (get the badge from codacy project settings).
7. Set an environment variable in travis called GITHUB_API_KEY with a Personal Access Token to commit Sphinx html to public repos.

Steps for how this project was set up can be found in the Presentation.pdf file in this repository, which was presented in December 2017 for the CAASTRO Code Workshops.

---

With Travis, CodeCov and Codacy set up, tests will run, cod style will be analyses, and documentation rebuilt, on each commit.

If you do not enable travis, you can run the tests your self by running (in the top level directory):

pytest -v --cov=. for *nix, and python -m pytest -v --cov=.

You can build documentation yourself by navigating to the doc directory, and running make clean && make html, which will build the HTML builds in the doc/_build/html directory. Open index.html in that directory to see the documentation.