diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt index 7afb182c..062121a9 100644 --- a/_sources/index.rst.txt +++ b/_sources/index.rst.txt @@ -20,7 +20,7 @@ Starting repositories can be created from this template so you can focus on what * Basic testing structure with `PyTest `_ * Automatic ``git`` initialization + tag * GitHub Hooks - * Automatic package version control with `Versioneer `_ + * Automatic package version control with `versioningit `_ * Sample data inclusion with packaging instructions * Basic documentation structure powered by `Sphinx `_ diff --git a/_sources/usage.rst.txt b/_sources/usage.rst.txt index e7832f6b..4f392158 100644 --- a/_sources/usage.rst.txt +++ b/_sources/usage.rst.txt @@ -125,5 +125,50 @@ To keep things clean and simple, we advise a few tips: for more information. +5. Tagging versions of your code +-------------------------------- + +Tagging versions of your code is a good way to keep references +to specific versions of your code that don't change. +This is especially useful when you want to make a new code +release. The ``cookiecutter`` uses `versioningit`_ to +automatically determine your package's version based on +git tags. + +By default, versioning will start from ``0.0.0``. +You can install versioningit_ to check the current versioningit output from commandline: + +.. code-block:: bash + + $ cd + $ versioningit . + 0.0.0 + +As you add commits, the versioning will automatically update with +the commit hashes: + +.. code-block:: bash + + $ versioningit . + 0.0.0+1.g58bcaff + +To tag a version, use the following command: + +.. code-block:: bash + + git tag -a 0.1.0 -m "Version 0.1.0" + +This will create a tag called ``0.1.0`` with the message +"Version 0.1.0". You can then push this tag to GitHub with ``git push origin --tags``. + +After creating a tag, you can check the versioning again: + +.. code-block:: bash + + $ versioningit . + 0.1.0 + + .. _ReadTheDocs: https://docs.readthedocs.io/en/stable/index.html -.. _cookiecutter: https://cookiecutter.readthedocs.io/en/stable/ \ No newline at end of file +.. _cookiecutter: https://cookiecutter.readthedocs.io/en/stable/ +.. _versioningit: https://versioningit.readthedocs.io/en/stable/index.html diff --git a/index.html b/index.html index 96f04a90..e5eed1af 100644 --- a/index.html +++ b/index.html @@ -132,7 +132,7 @@

Cookiecutter for MDAnalysis-based packagesPyTest

  • Automatic git initialization + tag

  • GitHub Hooks

    • -

  • Automatic package version control with Versioneer

    • +

  • Automatic package version control with versioningit

  • Sample data inclusion with packaging instructions

  • Basic documentation structure powered by Sphinx

    • diff --git a/searchindex.js b/searchindex.js index 866d6316..6e308cf5 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["cookiecutter/hooks", "cookiecutter/json_options", "index", "options", "usage"], "filenames": ["cookiecutter/hooks.rst", "cookiecutter/json_options.rst", "index.rst", "options.rst", "usage.rst"], "titles": ["Hook scripts", "cookiecutter.json", "Cookiecutter for MDAnalysis-based packages", "Options", "Usage"], "terms": {"thi": [0, 1, 2, 3, 4], "i": [0, 1, 2, 3, 4], "run": [0, 4], "after": 0, "user": [0, 1, 4], "ha": 0, "enter": [0, 4], "valu": [0, 1, 3], "prompt": [0, 1, 4], "befor": [0, 3, 4], "project": [0, 1, 3], "gener": [0, 3, 4], "two": 0, "import": [0, 2, 3, 4], "thing": [0, 4], "happen": 0, "here": [0, 1], "differ": [0, 4], "place": 0, "variabl": [0, 1], "ar": [0, 1, 3, 4], "substitut": 0, "back": [0, 3], "cookiecutt": [0, 3], "becaus": 0, "reli": 0, "jinja": [0, 1], "inject": 0, "occur": 0, "docstr": 0, "file": [0, 1, 2, 3, 4], "valid": [0, 4], "python": [0, 2, 3, 4], "The": [0, 2, 3, 4], "author_email": [0, 4], "repo_nam": [0, 4], "package_nam": [0, 4], "github_usernam": [0, 4], "github_host_account": [0, 4], "ttemplate_analysis_class": 0, "against": 0, "regular": 0, "express": 0, "It": [0, 3, 4], "accomplish": 0, "follow": [0, 1, 3, 4], "step": [0, 3], "remov": 0, "unnecessari": 0, "e": [0, 3, 4], "g": [0, 2, 3, 4], "templat": [0, 2, 3, 4], "analysi": [0, 3, 4], "class": [0, 3, 4], "specifi": 0, "tri": 0, "initi": [0, 2, 4], "git": [0, 2, 4], "repositori": [0, 2, 3, 4], "checkout": [0, 4], "main": [0, 4], "branch": [0, 4], "add": 0, "an": [0, 2, 3, 4], "commit": [0, 4], "0": [0, 1, 2, 3, 4], "1": [0, 1, 2, 3], "contain": [1, 3, 4], "us": [1, 3], "As": 1, "doe": [1, 3, 4], "allow": [1, 4], "comment": [1, 3], "some": [1, 3, 4], "note": [1, 3], "each": [1, 4], "kei": 1, "name": [1, 3, 4], "default": [1, 2, 3, 4], "sever": [1, 4], "limit": 1, "how": [1, 4], "inform": [1, 3, 4], "can": [1, 2, 3, 4], "we": [1, 3, 4], "want": 1, "support": [1, 2], "render": [1, 4], "spot": 1, "ask": 1, "choos": [1, 3, 4], "which": [1, 3, 4], "depend": [1, 2, 3, 4], "sourc": [1, 3, 4], "howev": [1, 3], "option": [1, 4], "veri": 1, "verbos": 1, "so": [1, 2, 4], "know": 1, "what": [1, 2, 3, 4], "thei": [1, 3], "That": 1, "quit": 1, "annoi": 1, "work": [1, 4], "result": 1, "therefor": 1, "should": [1, 3, 4], "sake": 1, "simplic": 1, "later": 1, "_dependency_source_kei": 1, "shorten": 1, "choic": [1, 2, 3], "correspond": 1, "conda": [1, 2, 4], "forg": [1, 2, 4], "prefer": [1, 3, 4], "over": [1, 4], "anaconda": [1, 4], "channel": [1, 3, 4], "pip": [1, 2, 4], "fallback": [1, 3, 4], "from": [1, 2, 3, 4], "onli": [1, 3, 4], "mdakit": [2, 4], "version": [2, 4], "A": [2, 4], "those": 2, "interest": 2, "develop": [2, 4], "start": 2, "creat": [2, 3], "you": [2, 3, 4], "focu": 2, "": [2, 4], "scienc": 2, "featur": 2, "centric": 2, "skelet": 2, "structur": 2, "modul": [2, 3], "pre": [2, 4], "configur": [2, 3, 4], "setup": [2, 3, 4], "py": [2, 3, 4], "instal": [2, 3, 4], "window": 2, "linux": 2, "osx": 2, "continu": [2, 3], "integr": [2, 3, 4], "github": [2, 3], "action": [2, 4], "locat": 2, "through": 2, "basic": 2, "test": [2, 3], "pytest": [2, 4], "automat": [2, 3, 4], "tag": 2, "hook": 2, "control": [2, 4], "sampl": [2, 4], "data": [2, 4], "inclus": 2, "instruct": [2, 4], "document": [2, 3], "power": 2, "sphinx": [2, 3], "heavili": 2, "off": 2, "comput": 2, "molecular": 2, "cm": 2, "levi": 2, "n": [2, 4], "naden": 2, "jessica": 2, "nash": 2, "softwar": 2, "institut": 2, "molssi": 2, "daniel": 2, "smith": 2, "ento": 2, "grant": 2, "chan": 2, "zuckerberg": 2, "under": 2, "eoss4": 2, "award": 2, "page": 3, "goe": 3, "mean": 3, "affect": 3, "If": 3, "explain": 3, "would": 3, "when": [3, 4], "write": 3, "about": 3, "anyth": 3, "have": [3, 4], "space": 3, "hyphen": 3, "directori": [3, 4], "packag": [3, 4], "cannot": 3, "url": [3, 4], "com": [3, 4], "lowercas": 3, "replac": 3, "underscor": 3, "your": 3, "must": 3, "rule": 3, "give": 3, "short": [3, 4], "appear": [3, 4], "readm": [3, 4], "person": [3, 4], "usernam": [3, 4], "credit": 3, "author": [3, 4], "md": [3, 4], "account": [3, 4], "host": [3, 4], "In": [3, 4], "most": 3, "case": 3, "same": [3, 4], "organis": 3, "set": [3, 4], "mdanalysi": [3, 4], "For": 3, "exampl": [3, 4], "logo": [3, 4], "favicon": 3, "also": [3, 4], "footer": 3, "detail": [3, 4], "our": 3, "privaci": 3, "polici": 3, "anoth": 3, "entri": 3, "conf": [3, 4], "placehold": 3, "pleas": [3, 4], "see": [3, 4], "theme": 3, "more": [3, 4], "go": [3, 4], "other": [3, 4], "materi": 3, "email": [3, 4], "address": 3, "comfort": 3, "get": [3, 4], "contact": 3, "point": 3, "code_of_conduct": [3, 4], "determin": 3, "well": [3, 4], "written": 3, "three": 3, "below": [3, 4], "look": 3, "first": [3, 4], "fall": 3, "highli": 3, "recommend": [3, 4], "great": 3, "manag": 3, "isol": 3, "environ": [3, 4], "between": 3, "them": 3, "moreov": 3, "mani": [3, 4], "avail": 3, "still": 3, "pypi": 3, "whether": 3, "includ": [3, 4], "readthedoc": 3, "yaml": [3, 4], "itself": 3, "keep": [3, 4], "standard": 3, "easi": 3, "wai": [3, 4], "build": [3, 4], "onlin": 3, "y": [3, 4], "true": 3, "trigger": [3, 4], "skeleton": [3, 4], "custom": 3, "associ": 3, "given": 3, "skip": [3, 4], "strongli": [3, 4], "encourag": 3, "plan": 3, "copi": 3, "help": [3, 4], "modifi": [3, 4], "up": 4, "requir": 4, "process": 4, "need": 4, "8": 4, "tool": 4, "illustr": 4, "line": 4, "actual": 4, "command": 4, "all": 4, "expect": 4, "answer": 4, "gh": 4, "11": 4, "project_nam": 4, "projectnam": 4, "my": 4, "my_project_nam": 4, "example_repositori": 4, "descript": 4, "do": 4, "5": 4, "6": 4, "organ": 4, "press": 4, "7": 4, "author_nam": 4, "compani": 4, "team": 4, "my_example_email": 4, "gmail": 4, "9": 4, "select": 4, "dependency_sourc": 4, "10": 4, "include_readthedoc": 4, "template_analysis_class": 4, "myprojectnam": 4, "myanalysisclass": 4, "output": 4, "yml": 4, "gitattribut": 4, "contribut": 4, "pull": 4, "request": 4, "guid": 4, "ci": 4, "issue_templ": 4, "open": 4, "issu": 4, "bug_report": 4, "feature_request": 4, "pull_request_templ": 4, "workflow": 4, "where": 4, "live": 4, "gitignor": 4, "stock": 4, "helper": 4, "tell": 4, "pattern": 4, "ignor": 4, "ad": 4, "config": 4, "flake8": 4, "isort": 4, "pylintrc": 4, "pylint": 4, "list": 4, "contributor": 4, "changelog": 4, "log": 4, "releas": 4, "conduct": 4, "licens": 4, "manifest": 4, "devtool": 4, "env": 4, "test_env": 4, "doc": 4, "folder": 4, "alreadi": 4, "fill": 4, "makefil": 4, "bat": 4, "specif": 4, "usual": 4, "smaller": 4, "than": 4, "program": 4, "_static": 4, "placeholder_favicon": 4, "svg": 4, "placeholder_logo": 4, "png": 4, "_templat": 4, "api": 4, "rst": 4, "getting_start": 4, "index": 4, "__init__": 4, "_version": 4, "addit": 4, "non": 4, "resolv": 4, "mda": 4, "txt": 4, "just": 4, "delet": 4, "product": 4, "unit": 4, "test_myanalysisclass": 4, "conftest": 4, "common": 4, "fixtur": 4, "test_package_nam": 4, "util": 4, "pyproject": 4, "toml": 4, "cfg": 4, "Near": 4, "master": 4, "yapf": 4, "etc": 4, "16": 4, "48": 4, "rest": 4, "tutori": 4, "section": 4, "initialis": 4, "now": 4, "connect": 4, "repo": 4, "ani": 4, "local": 4, "provid": 4, "remot": 4, "origin": 4, "u": 4, "verifi": 4, "were": 4, "successfulli": 4, "check": 4, "servic": 4, "These": 4, "manual": 4, "To": 4, "ensur": 4, "abl": 4, "click": 4, "button": 4, "dashboard": 4, "turn": 4, "preview": 4, "admin": 4, "tab": 4, "advanc": 4, "tick": 4, "checkbox": 4, "scroll": 4, "down": 4, "rememb": 4, "save": 4, "further": 4, "done": 4, "sign": 4, "app": 4, "mai": 4, "wait": 4, "few": 4, "hour": 4, "report": 4, "discov": 4, "part": 4, "current": 4, "ideal": 4, "aim": 4, "90": 4, "think": 4, "edit": 4, "forth": 4, "clean": 4, "simpl": 4, "advis": 4, "tip": 4, "alwai": 4, "virtual": 4, "like": 4, "environment_nam": 4, "activ": 4, "everi": 4, "time": 4, "updat": 4, "separ": 4, "central": 4, "avoid": 4, "mess": 4, "approach": 4, "multipl": 4, "peopl": 4, "b": 4, "my_branch_nam": 4, "feel": 4, "readi": 4, "finish": 4, "pr": 4, "review": 4, "sure": 4, "correct": 4, "good": 4, "feedback": 4, "collabor": 4}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"hook": [0, 4], "script": 0, "pre_gen_project": 0, "py": 0, "post_gen_project": 0, "cookiecutt": [1, 2, 4], "json": 1, "format": 1, "dependency_sourc": [1, 3], "__dependency_sourc": 1, "mdanalysi": 2, "base": 2, "packag": 2, "acknowledg": 2, "option": 3, "project_nam": 3, "repo_nam": 3, "package_nam": 3, "descript": 3, "github_usernam": 3, "github_host_account": 3, "author_nam": 3, "author_email": 3, "conda": 3, "forg": 3, "anaconda": 3, "pip": 3, "include_readthedoc": 3, "template_analysis_class": 3, "usag": 4, "1": 4, "us": 4, "creat": 4, "new": 4, "project": 4, "2": 4, "add": 4, "github": 4, "3": 4, "link": 4, "extern": 4, "document": 4, "readthedoc": 4, "test": 4, "coverag": 4, "codecov": 4, "4": 4, "make": 4, "push": 4, "chang": 4, "your": 4, "code": 4}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Hook scripts": [[0, "hook-scripts"]], "pre_gen_project.py": [[0, "pre-gen-project-py"]], "post_gen_project.py": [[0, "post-gen-project-py"]], "cookiecutter.json": [[1, "cookiecutter-json"]], "Format": [[1, "format"]], "dependency_source": [[1, "dependency-source"], [3, "dependency-source"]], "dependency_source to __dependency_source": [[1, "id1"]], "Cookiecutter for MDAnalysis-based packages": [[2, "cookiecutter-for-mdanalysis-based-packages"]], "Acknowledgments": [[2, "acknowledgments"]], "Options": [[3, "options"]], "project_name": [[3, "project-name"]], "repo_name": [[3, "repo-name"]], "package_name": [[3, "package-name"]], "description": [[3, "description"]], "github_username": [[3, "github-username"]], "github_host_account": [[3, "github-host-account"]], "author_name": [[3, "author-name"]], "author_email": [[3, "author-email"]], "conda-forge": [[3, "conda-forge"]], "anaconda": [[3, "anaconda"]], "pip": [[3, "pip"]], "include_ReadTheDocs": [[3, "include-readthedocs"]], "template_analysis_class": [[3, "template-analysis-class"]], "Usage": [[4, "usage"]], "1. Use the cookiecutter to create a new project": [[4, "use-the-cookiecutter-to-create-a-new-project"]], "2. Add the project to GitHub": [[4, "add-the-project-to-github"]], "3. Link external hooks": [[4, "link-external-hooks"]], "Documentation: ReadTheDocs": [[4, "documentation-readthedocs"]], "Test coverage: Codecov": [[4, "test-coverage-codecov"]], "4. Make and push changes to your code": [[4, "make-and-push-changes-to-your-code"]]}, "indexentries": {}}) \ No newline at end of file +Search.setIndex({"docnames": ["cookiecutter/hooks", "cookiecutter/json_options", "index", "options", "usage"], "filenames": ["cookiecutter/hooks.rst", "cookiecutter/json_options.rst", "index.rst", "options.rst", "usage.rst"], "titles": ["Hook scripts", "cookiecutter.json", "Cookiecutter for MDAnalysis-based packages", "Options", "Usage"], "terms": {"thi": [0, 1, 2, 3, 4], "i": [0, 1, 2, 3, 4], "run": [0, 4], "after": [0, 4], "user": [0, 1, 4], "ha": 0, "enter": [0, 4], "valu": [0, 1, 3], "prompt": [0, 1, 4], "befor": [0, 3, 4], "project": [0, 1, 3], "gener": [0, 3, 4], "two": 0, "import": [0, 2, 3, 4], "thing": [0, 4], "happen": 0, "here": [0, 1], "differ": [0, 4], "place": 0, "variabl": [0, 1], "ar": [0, 1, 3, 4], "substitut": 0, "back": [0, 3], "cookiecutt": [0, 3], "becaus": 0, "reli": 0, "jinja": [0, 1], "inject": 0, "occur": 0, "docstr": 0, "file": [0, 1, 2, 3, 4], "valid": [0, 4], "python": [0, 2, 3, 4], "The": [0, 2, 3, 4], "author_email": [0, 4], "repo_nam": [0, 4], "package_nam": [0, 4], "github_usernam": [0, 4], "github_host_account": [0, 4], "ttemplate_analysis_class": 0, "against": 0, "regular": 0, "express": 0, "It": [0, 3, 4], "accomplish": 0, "follow": [0, 1, 3, 4], "step": [0, 3], "remov": 0, "unnecessari": 0, "e": [0, 3, 4], "g": [0, 2, 3, 4], "templat": [0, 2, 3, 4], "analysi": [0, 3, 4], "class": [0, 3, 4], "specifi": 0, "tri": 0, "initi": [0, 2, 4], "git": [0, 2, 4], "repositori": [0, 2, 3, 4], "checkout": [0, 4], "main": [0, 4], "branch": [0, 4], "add": 0, "an": [0, 2, 3, 4], "commit": [0, 4], "0": [0, 1, 2, 3, 4], "1": [0, 1, 2, 3], "contain": [1, 3, 4], "us": [1, 3], "As": [1, 4], "doe": [1, 3, 4], "allow": [1, 4], "comment": [1, 3], "some": [1, 3, 4], "note": [1, 3], "each": [1, 4], "kei": 1, "name": [1, 3, 4], "default": [1, 2, 3, 4], "sever": [1, 4], "limit": 1, "how": [1, 4], "inform": [1, 3, 4], "can": [1, 2, 3, 4], "we": [1, 3, 4], "want": [1, 4], "support": [1, 2], "render": [1, 4], "spot": 1, "ask": 1, "choos": [1, 3, 4], "which": [1, 3, 4], "depend": [1, 2, 3, 4], "sourc": [1, 3, 4], "howev": [1, 3], "option": [1, 4], "veri": 1, "verbos": 1, "so": [1, 2, 4], "know": 1, "what": [1, 2, 3, 4], "thei": [1, 3], "That": 1, "quit": 1, "annoi": 1, "work": [1, 4], "result": 1, "therefor": 1, "should": [1, 3, 4], "sake": 1, "simplic": 1, "later": 1, "_dependency_source_kei": 1, "shorten": 1, "choic": [1, 2, 3], "correspond": 1, "conda": [1, 2, 4], "forg": [1, 2, 4], "prefer": [1, 3, 4], "over": [1, 4], "anaconda": [1, 4], "channel": [1, 3, 4], "pip": [1, 2, 4], "fallback": [1, 3, 4], "from": [1, 2, 3, 4], "onli": [1, 3, 4], "mdakit": [2, 4], "version": 2, "A": [2, 4], "those": 2, "interest": 2, "develop": [2, 4], "start": [2, 4], "creat": [2, 3], "you": [2, 3, 4], "focu": 2, "": [2, 4], "scienc": 2, "featur": 2, "centric": 2, "skelet": 2, "structur": 2, "modul": [2, 3], "pre": [2, 4], "configur": [2, 3, 4], "setup": [2, 3], "py": [2, 3, 4], "instal": [2, 3, 4], "window": 2, "linux": 2, "osx": 2, "continu": [2, 3], "integr": [2, 3, 4], "github": [2, 3], "action": [2, 4], "locat": 2, "through": 2, "basic": 2, "test": [2, 3], "pytest": [2, 4], "automat": [2, 3, 4], "tag": 2, "hook": 2, "control": 2, "versioningit": [2, 4], "sampl": [2, 4], "data": [2, 4], "inclus": 2, "instruct": [2, 4], "document": [2, 3], "power": 2, "sphinx": [2, 3], "heavili": 2, "off": 2, "comput": 2, "molecular": 2, "cm": 2, "levi": 2, "n": [2, 4], "naden": 2, "jessica": 2, "nash": 2, "softwar": 2, "institut": 2, "molssi": 2, "daniel": 2, "smith": 2, "ento": 2, "grant": 2, "chan": 2, "zuckerberg": 2, "under": 2, "eoss4": 2, "award": 2, "page": 3, "goe": 3, "mean": 3, "affect": 3, "If": 3, "explain": 3, "would": 3, "when": [3, 4], "write": 3, "about": 3, "anyth": 3, "have": [3, 4], "space": 3, "hyphen": 3, "directori": [3, 4], "packag": [3, 4], "cannot": 3, "url": [3, 4], "com": [3, 4], "lowercas": 3, "replac": 3, "underscor": 3, "your": 3, "must": 3, "rule": 3, "give": 3, "short": [3, 4], "appear": [3, 4], "readm": [3, 4], "person": [3, 4], "usernam": [3, 4], "credit": 3, "author": [3, 4], "md": [3, 4], "account": [3, 4], "host": [3, 4], "In": [3, 4], "most": 3, "case": 3, "same": [3, 4], "organis": 3, "set": [3, 4], "mdanalysi": [3, 4], "For": 3, "exampl": [3, 4], "logo": [3, 4], "favicon": 3, "also": [3, 4], "footer": 3, "detail": [3, 4], "our": 3, "privaci": 3, "polici": 3, "anoth": 3, "entri": 3, "conf": [3, 4], "placehold": 3, "pleas": [3, 4], "see": [3, 4], "theme": 3, "more": [3, 4], "go": [3, 4], "other": [3, 4], "materi": 3, "email": [3, 4], "address": 3, "comfort": 3, "get": [3, 4], "contact": 3, "point": 3, "code_of_conduct": [3, 4], "determin": [3, 4], "well": [3, 4], "written": 3, "three": 3, "below": [3, 4], "look": 3, "first": [3, 4], "fall": 3, "highli": 3, "recommend": [3, 4], "great": 3, "manag": 3, "isol": 3, "environ": [3, 4], "between": 3, "them": 3, "moreov": 3, "mani": [3, 4], "avail": 3, "still": 3, "pypi": 3, "whether": 3, "includ": [3, 4], "readthedoc": 3, "yaml": [3, 4], "itself": 3, "keep": [3, 4], "standard": 3, "easi": 3, "wai": [3, 4], "build": [3, 4], "onlin": 3, "y": [3, 4], "true": 3, "trigger": [3, 4], "skeleton": [3, 4], "custom": 3, "associ": 3, "given": 3, "skip": [3, 4], "strongli": [3, 4], "encourag": 3, "plan": 3, "copi": 3, "help": [3, 4], "modifi": [3, 4], "up": 4, "requir": 4, "process": 4, "need": 4, "8": 4, "tool": 4, "illustr": 4, "line": 4, "actual": 4, "command": 4, "all": 4, "expect": 4, "answer": 4, "gh": 4, "11": 4, "project_nam": 4, "projectnam": 4, "my": 4, "my_project_nam": 4, "example_repositori": 4, "descript": 4, "do": 4, "6": 4, "organ": 4, "press": 4, "7": 4, "author_nam": 4, "compani": 4, "team": 4, "my_example_email": 4, "gmail": 4, "9": 4, "select": 4, "dependency_sourc": 4, "10": 4, "include_readthedoc": 4, "template_analysis_class": 4, "myprojectnam": 4, "myanalysisclass": 4, "output": 4, "yml": 4, "gitattribut": 4, "contribut": 4, "pull": 4, "request": 4, "guid": 4, "ci": 4, "issue_templ": 4, "open": 4, "issu": 4, "bug_report": 4, "feature_request": 4, "pull_request_templ": 4, "workflow": 4, "where": 4, "live": 4, "gitignor": 4, "stock": 4, "helper": 4, "tell": 4, "pattern": 4, "ignor": 4, "ad": 4, "config": 4, "flake8": 4, "isort": 4, "pylintrc": 4, "pylint": 4, "list": 4, "contributor": 4, "changelog": 4, "log": 4, "releas": 4, "conduct": 4, "licens": 4, "manifest": 4, "devtool": 4, "env": 4, "test_env": 4, "doc": 4, "folder": 4, "alreadi": 4, "fill": 4, "makefil": 4, "bat": 4, "specif": 4, "usual": 4, "smaller": 4, "than": 4, "program": 4, "_static": 4, "placeholder_favicon": 4, "svg": 4, "placeholder_logo": 4, "png": 4, "_templat": 4, "api": 4, "rst": 4, "getting_start": 4, "index": 4, "__init__": 4, "addit": 4, "non": 4, "resolv": 4, "mda": 4, "txt": 4, "just": 4, "delet": 4, "product": 4, "unit": 4, "test_myanalysisclass": 4, "conftest": 4, "common": 4, "fixtur": 4, "test_package_nam": 4, "util": 4, "pyproject": 4, "toml": 4, "16": 4, "44": 4, "rest": 4, "tutori": 4, "section": 4, "initialis": 4, "now": 4, "connect": 4, "repo": 4, "ani": 4, "local": 4, "provid": 4, "remot": 4, "origin": 4, "u": 4, "verifi": 4, "were": 4, "successfulli": 4, "check": 4, "servic": 4, "These": 4, "manual": 4, "To": 4, "ensur": 4, "abl": 4, "click": 4, "button": 4, "dashboard": 4, "turn": 4, "preview": 4, "admin": 4, "tab": 4, "advanc": 4, "tick": 4, "checkbox": 4, "scroll": 4, "down": 4, "rememb": 4, "save": 4, "further": 4, "done": 4, "sign": 4, "app": 4, "mai": 4, "wait": 4, "few": 4, "hour": 4, "report": 4, "discov": 4, "part": 4, "current": 4, "ideal": 4, "aim": 4, "90": 4, "think": 4, "edit": 4, "forth": 4, "clean": 4, "simpl": 4, "advis": 4, "tip": 4, "alwai": 4, "virtual": 4, "like": 4, "environment_nam": 4, "activ": 4, "everi": 4, "time": 4, "updat": 4, "separ": 4, "central": 4, "avoid": 4, "mess": 4, "approach": 4, "multipl": 4, "peopl": 4, "b": 4, "my_branch_nam": 4, "feel": 4, "readi": 4, "finish": 4, "pr": 4, "review": 4, "sure": 4, "correct": 4, "good": 4, "feedback": 4, "collabor": 4, "refer": 4, "don": 4, "t": 4, "especi": 4, "base": 4, "By": 4, "commandlin": 4, "cd": 4, "my_package_directori": 4, "hash": 4, "g58bcaff": 4, "m": 4, "call": 4, "messag": 4, "again": 4}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"hook": [0, 4], "script": 0, "pre_gen_project": 0, "py": 0, "post_gen_project": 0, "cookiecutt": [1, 2, 4], "json": 1, "format": 1, "dependency_sourc": [1, 3], "__dependency_sourc": 1, "mdanalysi": 2, "base": 2, "packag": 2, "acknowledg": 2, "option": 3, "project_nam": 3, "repo_nam": 3, "package_nam": 3, "descript": 3, "github_usernam": 3, "github_host_account": 3, "author_nam": 3, "author_email": 3, "conda": 3, "forg": 3, "anaconda": 3, "pip": 3, "include_readthedoc": 3, "template_analysis_class": 3, "usag": 4, "1": 4, "us": 4, "creat": 4, "new": 4, "project": 4, "2": 4, "add": 4, "github": 4, "3": 4, "link": 4, "extern": 4, "document": 4, "readthedoc": 4, "test": 4, "coverag": 4, "codecov": 4, "4": 4, "make": 4, "push": 4, "chang": 4, "your": 4, "code": 4, "5": 4, "tag": 4, "version": 4}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Hook scripts": [[0, "hook-scripts"]], "pre_gen_project.py": [[0, "pre-gen-project-py"]], "post_gen_project.py": [[0, "post-gen-project-py"]], "cookiecutter.json": [[1, "cookiecutter-json"]], "Format": [[1, "format"]], "dependency_source": [[1, "dependency-source"], [3, "dependency-source"]], "dependency_source to __dependency_source": [[1, "id1"]], "Cookiecutter for MDAnalysis-based packages": [[2, "cookiecutter-for-mdanalysis-based-packages"]], "Acknowledgments": [[2, "acknowledgments"]], "Options": [[3, "options"]], "project_name": [[3, "project-name"]], "repo_name": [[3, "repo-name"]], "package_name": [[3, "package-name"]], "description": [[3, "description"]], "github_username": [[3, "github-username"]], "github_host_account": [[3, "github-host-account"]], "author_name": [[3, "author-name"]], "author_email": [[3, "author-email"]], "conda-forge": [[3, "conda-forge"]], "anaconda": [[3, "anaconda"]], "pip": [[3, "pip"]], "include_ReadTheDocs": [[3, "include-readthedocs"]], "template_analysis_class": [[3, "template-analysis-class"]], "Usage": [[4, "usage"]], "1. Use the cookiecutter to create a new project": [[4, "use-the-cookiecutter-to-create-a-new-project"]], "2. Add the project to GitHub": [[4, "add-the-project-to-github"]], "3. Link external hooks": [[4, "link-external-hooks"]], "Documentation: ReadTheDocs": [[4, "documentation-readthedocs"]], "Test coverage: Codecov": [[4, "test-coverage-codecov"]], "4. Make and push changes to your code": [[4, "make-and-push-changes-to-your-code"]], "5. Tagging versions of your code": [[4, "tagging-versions-of-your-code"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/usage.html b/usage.html index a0f4d166..ecbb27cd 100644 --- a/usage.html +++ b/usage.html @@ -92,6 +92,7 @@
  • 4. Make and push changes to your code
    • +
  • 5. Tagging versions of your code
  • Options
    • @@ -211,7 +212,6 @@

    1. Use the cookiecutter to create a new project +

    5. Tagging versions of your code

    +

    Tagging versions of your code is a good way to keep references +to specific versions of your code that don’t change. +This is especially useful when you want to make a new code +release. The cookiecutter uses versioningit to +automatically determine your package’s version based on +git tags.

    +

    By default, versioning will start from 0.0.0. +You can install versioningit to check the current versioningit output from commandline:

    +
    $ cd <my_package_directory>
+$ versioningit .
+0.0.0
+
    +
    +

    As you add commits, the versioning will automatically update with +the commit hashes:

    +
    $ versioningit .
+0.0.0+1.g58bcaff
+
    +
    +

    To tag a version, use the following command:

    +
    git tag -a 0.1.0 -m "Version 0.1.0"
+
    +
    +

    This will create a tag called 0.1.0 with the message +“Version 0.1.0”. You can then push this tag to GitHub with git push origin --tags.

    +

    After creating a tag, you can check the versioning again:

    +
    $ versioningit .
+0.1.0
+
    +
    +