Loading Makefile +1 −1 Original line number Diff line number Diff line Loading @@ -14,7 +14,7 @@ help: # re-format python files, # use local maximum line-length convention .. black: black --line-length=99 py doc/source/conf.py black --line-length=99 src doc/source/conf.py # generate documentation: docu: Loading doc/source/conf.py +3 −1 Original line number Diff line number Diff line Loading @@ -12,6 +12,7 @@ # import os import sys # sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "src"))) sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "src", "utopya"))) Loading @@ -35,6 +36,7 @@ if not os.path.isfile(ppfile): else: # modules: import toml # open file: with open(ppfile, "r") as f: config = toml.load(f) Loading doc/source/history.rst +6 −8 Original line number Diff line number Diff line Loading @@ -159,7 +159,7 @@ A wishlist of developments. How to create a version tag =========================== Example for tag "v2.11". Example for tag "v2.12". 1. Update file formatting following conventions. Loading @@ -177,21 +177,19 @@ Example for tag "v2.11". b. Update the source file `doc/source/history.rst <../../source/history.rst>`_ of this chapter. c. Change the release tag that will be shown in the documentation in the file `doc/source/conf.py <../../source/conf.py>`_:: c. Change the release tag that will also be imported to the documenation in the `pyproject.toml <../../../pyproject.toml>`_ file:: # The full version, including alpha/beta/rc tags release = "v2.11" release = "2.12" d. Commit and push these changes:: git commit -m 'Defined v2.11' . git commit -m 'Defined v2.12' . git push 4. Tag and push the code to the git repository:: git tag -a 'v2.11' -m 'Tagged v2.11' git push origin v2.11 git tag -a 'v2.12' -m 'Tagged v2.12' git push origin v2.12 src/cso/__init__.py +1 −0 Original line number Diff line number Diff line Loading @@ -109,6 +109,7 @@ and are defined according to the following hierchy: # store version number: from importlib import metadata __version__ = metadata.version(__package__) # import entities from sub-modules: Loading src/cso/scripts/cli.py +1 −0 Original line number Diff line number Diff line Loading @@ -32,6 +32,7 @@ def callback( ): """🛰️ CAMS Satellite Operator (CSO) Command Line Interface""" @main.command() def run(rc_file: str = typer.Argument(..., help="Provide .rc file")): """Run cso based on settings provided in .rc file (e.g., cso run config/tutorial/tutorial.rc)""" Loading Loading
Makefile +1 −1 Original line number Diff line number Diff line Loading @@ -14,7 +14,7 @@ help: # re-format python files, # use local maximum line-length convention .. black: black --line-length=99 py doc/source/conf.py black --line-length=99 src doc/source/conf.py # generate documentation: docu: Loading
doc/source/conf.py +3 −1 Original line number Diff line number Diff line Loading @@ -12,6 +12,7 @@ # import os import sys # sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "src"))) sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "src", "utopya"))) Loading @@ -35,6 +36,7 @@ if not os.path.isfile(ppfile): else: # modules: import toml # open file: with open(ppfile, "r") as f: config = toml.load(f) Loading
doc/source/history.rst +6 −8 Original line number Diff line number Diff line Loading @@ -159,7 +159,7 @@ A wishlist of developments. How to create a version tag =========================== Example for tag "v2.11". Example for tag "v2.12". 1. Update file formatting following conventions. Loading @@ -177,21 +177,19 @@ Example for tag "v2.11". b. Update the source file `doc/source/history.rst <../../source/history.rst>`_ of this chapter. c. Change the release tag that will be shown in the documentation in the file `doc/source/conf.py <../../source/conf.py>`_:: c. Change the release tag that will also be imported to the documenation in the `pyproject.toml <../../../pyproject.toml>`_ file:: # The full version, including alpha/beta/rc tags release = "v2.11" release = "2.12" d. Commit and push these changes:: git commit -m 'Defined v2.11' . git commit -m 'Defined v2.12' . git push 4. Tag and push the code to the git repository:: git tag -a 'v2.11' -m 'Tagged v2.11' git push origin v2.11 git tag -a 'v2.12' -m 'Tagged v2.12' git push origin v2.12
src/cso/__init__.py +1 −0 Original line number Diff line number Diff line Loading @@ -109,6 +109,7 @@ and are defined according to the following hierchy: # store version number: from importlib import metadata __version__ = metadata.version(__package__) # import entities from sub-modules: Loading
src/cso/scripts/cli.py +1 −0 Original line number Diff line number Diff line Loading @@ -32,6 +32,7 @@ def callback( ): """🛰️ CAMS Satellite Operator (CSO) Command Line Interface""" @main.command() def run(rc_file: str = typer.Argument(..., help="Provide .rc file")): """Run cso based on settings provided in .rc file (e.g., cso run config/tutorial/tutorial.rc)""" Loading