Commit graph

112 commits

Author SHA1 Message Date
f6fe831039
Add installation sections
- add section "Installation"
  + explain how Anaconda is set up
  + include many screenshots
  + explain how the repo is downloaded as a zip archive
- add a section "Alternative Installation"
  + explain how git, poetry, and pyenv can be used
    to set up the project as well
  + explain what a CLI is (with screenshots)
2020-10-12 15:21:39 +02:00
cd783a6ac7
Add prerequisites section 2020-10-12 12:03:34 +02:00
c67d26b787
Pin the dependencies
- use Poetry 1.1
- re-oder the keys in poetry.lock
- upgrade transient dependencies:
  + colorlog
  + identify
  + nbconvert
  + virtualenv
2020-10-12 11:28:27 +02:00
b0a5b49664
Add init-project task
- add a nox session "init-project"
  + it installs the pre-commit hooks
  + being a task, the session is run in the develop environment
2020-10-02 16:31:36 +02:00
b2b29d9ec0
Configure pre-commit hooks
- run "fix-branch-references" before every commit
- add common pre-commit hooks from the pre-commit framework
2020-10-02 16:27:48 +02:00
b3b8a0d5ab
Add pre-commit to the develop dependencies 2020-10-02 16:19:54 +02:00
d88dc0f91c
Add fix-branch-references task
- add nox session "fix-branch-references"
  + the session is a task executed in the normal develop environment
  + it rewrites all branch labels in links in *.ipynb and *.md files
2020-10-02 16:15:30 +02:00
3b9fc59cb6
Add noxfile 2020-10-02 15:34:31 +02:00
fc87305922
Add nox to the develop dependencies 2020-10-02 15:18:40 +02:00
1351adaa62
Ignore Jupyter's checkpoint files 2020-09-30 16:33:33 +02:00
9fbfb9de8d
Add jupyterlab to the dependencies 2020-09-30 16:21:56 +02:00
057a9229d5
Initial commit
- add the following files:
  + LICENSE.txt => use MIT license as the project should be
                   accessible to anybody who wants to learn Python
  + README.md => provide a rough description of the project
  + pyproject.toml => initialize poetry and the add project metadata
  + poetry.lock => initialize poetry
  + .gitignore => hide pyenv and poetry artifacts
  + static/link/ => folder holding images for links
- for the pre-2020 version of the files, check out the "v0.0.0" tag
2020-09-30 16:04:36 +02:00