Mention nox and init task
This commit is contained in:
parent
0c754f1c7b
commit
955fb74673
2 changed files with 15 additions and 1 deletions
11
README.md
11
README.md
|
@ -205,7 +205,16 @@ The following *one* command not only
|
||||||
[poetry](https://python-poetry.org/docs/) is also used
|
[poetry](https://python-poetry.org/docs/) is also used
|
||||||
to execute commands in the project's (virtual) environment.
|
to execute commands in the project's (virtual) environment.
|
||||||
The command is then prefixed with `poetry run ...`.
|
The command is then prefixed with `poetry run ...`.
|
||||||
For example, to do the equivalent of clicking "Launch" in the Anaconda Navigator:
|
|
||||||
|
The project uses [nox](https://nox.thea.codes/en/stable/)
|
||||||
|
to manage various maintenance tasks.
|
||||||
|
After cloning the repository and setting up the virual environment,
|
||||||
|
it is recommended to run the initialization task.
|
||||||
|
That needs to be done only once.
|
||||||
|
|
||||||
|
- `poetry run nox -s init-project`
|
||||||
|
|
||||||
|
To do the equivalent of clicking "Launch" in the Anaconda Navigator:
|
||||||
|
|
||||||
- `poetry run jupyter lab`
|
- `poetry run jupyter lab`
|
||||||
|
|
||||||
|
|
|
@ -39,6 +39,11 @@ def init_project(session):
|
||||||
):
|
):
|
||||||
session.run("poetry", "run", "pre-commit", "install", f"--hook-type={type_}")
|
session.run("poetry", "run", "pre-commit", "install", f"--hook-type={type_}")
|
||||||
|
|
||||||
|
# Copy the extensions' JavaScript and CSS files into Jupyter's search directory.
|
||||||
|
session.run(
|
||||||
|
"poetry", "run", "jupyter", "contrib", "nbextension", "install", "--user"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@nox.session(name="fix-branch-references", venv_backend="none")
|
@nox.session(name="fix-branch-references", venv_backend="none")
|
||||||
def fix_branch_references(_session):
|
def fix_branch_references(_session):
|
||||||
|
|
Loading…
Reference in a new issue