notebook

What is this repository?

This is the code repository associated with my development notes notebook.

I need it to improve development efficiency. I study concepts, prototype solutions, save them here along with their comments. When needed, I know where I can quickly find code examples to reuse.

Some useful commands

---

Error message suppression:

1. To suppress mypy errors: # type: ignore[<error-id>].
2. To suppress bandit reports: # nosec <report-id>.
3. To suppress flake8 errors: # noqa: <error-id>.

---

To run pre-commit checks manually: pre-commit run --all-files

---

To build the Python package:

1. Perform a commit.
2. Run this command in the IDE terminal:

python -m build

---

To start the local MKDocs development server, run this command in the IDE terminal:

mkdocs serve

After starting the server, documentation is usually available at the following address: http://127.0.0.1:8000/

---

CI/CD notes

1. Service directories of the CI server should be excluded from mypy and flake8 checks.

I have an error or have a question or idea💡. What to do?

There are two options:

1. Create an Issue and describe the situation:
   1. GitLab: https://gitlab.com/vkolupaev/notebook/-/issues
   2. GitHub: https://github.com/ViacheslavKolupaev/notebook/issues
2. Please feel free to write to me. My contacts are listed below 👇.

---

Copyright 2022 Viacheslav Kolupaev.