Skip to content
/ template Public template

This repository stands to house a skeleton of what all repos (especially those containing python code), can look like.

License

Notifications You must be signed in to change notification settings

CIERA-Northwestern/template

Repository files navigation

template

This repository stands to house a skeleton of what all repos (especially those containing python code), can look like.

badges

codecov Unit Test YOURPACKAGE

Documentation URL

Documentation

Using this template

First steps

In the top right corner there should be a Green Use Template button. Click this and name your new repository

After this, you will want to git clone the repository locally and then use git grep to find and replace files with the correct information. The command for doing this find and repalce is linked here.

An example of the commands would be (On MAC)

git grep -l 'YOURPACKAGE' | xargs sed -i '' -e 's/YOURPACKAGE/mypackage/g'
git grep -l 'YOUR NAME' | xargs sed -i '' -e 's/YOUR NAME/myname/g'
git grep -l 'YOUREMAIL' | xargs sed -i '' -e 's/YOUREMAIL/myemail/g'

After you have done this, you must also change the name of the package in the repo using git mv

git mv YOURPACKAGE/ mypackage

Now we can commit and update the template so we are ready for developing your own package.

git commit -m "Updating template"
git push

Activating the Continous Integration

In order for the code coverage and continuous integration to work you must allow 3rd party access codecov to access your Github repo. To do this, you must sign into the services (you can justuse your GitHub account to do so).

Code coverage

Examples of some repositories with these files

https://github.com/Gravity-Spy/GravitySpy

https://github.com/COSMIC-PopSynth/COSMIC

About

This repository stands to house a skeleton of what all repos (especially those containing python code), can look like.

Resources

License

Stars

Watchers

Forks

Packages

No packages published