📝 Switch to .venv directory

Author: veit

README.rst

@@ -56,7 +56,7 @@ Installation
    .. code-block:: ps1con
 
       C:> py -m venv .venv
-      C:> .\.venv\Scripts\Activate
+      C:> .\.venv\Scripts\activate.bat
       C:> python -m pip install --upgrade pip
       C:> python -m pip install -e ".[dev]"
 

docs/document/start.rst

@@ -10,32 +10,31 @@ Installation and start
 
       .. code-block:: console
 
-         $ python3 -m venv venv
+         $ python3 -m venv .venv
 
    .. tab:: Windows
 
       .. code-block:: ps1con
 
-         C:> python -m venv venv
+         C:> python -m venv .venv
 
 #. Switch to the virtual environment and install Sphinx there:
 
    .. tab:: Linux/macOS
 
       .. code-block:: console
 
-         $ cd !$
-         cd venv
-         $ bin/python -m pip install sphinx
+         $ . .venv/bin/activate
+         $ (.venv) python -m pip install sphinx
          Creating a virtualenv for this project…
          …
 
    .. tab:: Windows
 
       .. code-block:: ps1con
 
-         C:> cd venv
-         C:> bin/python -m pip install sphinx
+         C:> .venv\Scripts\activate.bat
+         C:> (.venv) python -m pip install sphinx
          Creating a virtualenv for this project…
          …
 
@@ -45,7 +44,7 @@ Installation and start
 
       .. code-block:: console
 
-         $ bin/sphinx-quickstart docs
+         $ sphinx-quickstart docs
          Selected root path: docs
          > Separate source and build directories (y/n) [n]:
          > Name prefix for templates and static dir [_]:
@@ -77,7 +76,7 @@ Installation and start
 
       .. code-block:: ps1con
 
-         C:> Scripts\sphinx-quickstart docs
+         C:> sphinx-quickstart docs
          Selected root path: docs
          > Separate source and build directories (y/n) [n]:
          > Name prefix for templates and static dir [_]:
@@ -110,7 +109,7 @@ Sphinx layout
 
 ::
 
-    venv
+    .
     └── docs
         ├── Makefile
         ├── _static
@@ -132,13 +131,13 @@ You can now generate the documentation, for example with:
 
    .. code-block:: console
 
-      $ bin/sphinx-build -ab html docs/ docs/_build
+      $ sphinx-build -ab html docs/ docs/_build
 
 .. tab:: Windows
 
    .. code-block:: ps1con
 
-      C:> Scripts\sphinx-build -ab html docs\ docs\_build
+      C:> sphinx-build -ab html docs\ docs\_build
 
 ``a``
     regenerates all pages of the documentation.

docs/document/test.rst

@@ -17,13 +17,13 @@ mode for this, which can be called up with the ``-n`` option, for example with:
 
    .. code-block:: console
 
-       $ bin/python -m sphinx -nb html docs/ docs/_build/
+       $ python -m sphinx -nb html docs/ docs/_build/
 
 .. tab:: Windows
 
    .. code-block:: ps1con
 
-       C:> Scripts\python -m sphinx -nb html docs\ docs\_build\
+       C:> python -m sphinx -nb html docs\ docs\_build\
 
 .. _link-checks:
 
@@ -38,21 +38,21 @@ which you can call up with:
 
    .. code-block:: console
 
-       $ bin/python -m sphinx -b linkcheck docs/ docs/_build/
+       $ python -m sphinx -b linkcheck docs/ docs/_build/
 
 .. tab:: Windows
 
    .. code-block:: ps1con
 
-       C:> Scripts\python -m sphinx -b linkcheck docs\ docs\_build\
+       C:> python -m sphinx -b linkcheck docs\ docs\_build\
 
 The output can then look like this, for example:
 
 .. tab:: Linux/macOS
 
    .. code-block:: console
 
-       $ bin/python -m sphinx -b linkcheck docs/ docs/_build/
+       $ python -m sphinx -b linkcheck docs/ docs/_build/
        Running Sphinx v3.5.2
        loading translations [de]... done
        …
@@ -71,7 +71,7 @@ The output can then look like this, for example:
 
    .. code-block:: ps1con
 
-       C:> Scripts\python -m sphinx -b linkcheck docs\ docs\_build\
+       C:> python -m sphinx -b linkcheck docs\ docs\_build\
        Running Sphinx v3.5.2
        loading translations [de]... done
        …

docs/document/uml/index.rst

@@ -25,13 +25,13 @@ Installation
 
       .. code-block:: console
 
-         $ bin/python -m pip install sphinxcontrib-plantuml
+         $ python -m pip install sphinxcontrib-plantuml
 
    .. tab:: Windows
 
       .. code-block:: ps1con
 
-         C:> Scripts\python -m pip install sphinxcontrib-plantuml
+         C:> python -m pip install sphinxcontrib-plantuml
 
 #. We then configure the ``conf.py``:
 

docs/libs/distribution.rst

@@ -297,20 +297,20 @@ You can install these optional dependencies, for example with:
    .. code-block:: console
 
       $ cd /PATH/TO/YOUR/DISTRIBUTION_PACKAGE
-      $ python3 -m venv .
-      $ . bin/activate
+      $ python3 -m venv .venv
+      $ . .venv/bin/activate
       $ python -m pip install --upgrade pip
-      $ python -m pip install -e '.[dev]'
+      $ python -m pip install -e ".[dev]"
 
 .. tab:: Windows
 
    .. code-block:: ps1
 
       > cd C:\PATH\TO\YOUR\DISTRIBUTION_PACKAGE
-      > python3 -m venv .
-      > Scripts\activate.bat
+      > python3 -m venv .venv
+      > .venv\Scripts\activate.bat
       > python -m pip install --upgrade pip
-      > python -m pip install -e '.[dev]'
+      > python -m pip install -e ".[dev]"
 
 :file:`src` package
 -------------------
@@ -534,29 +534,29 @@ Testing
 
       $ mkdir test_env
       $ cd test_env
-      $ python3 -m venv .
-      $ source bin/activate
-      $ python -m pip install dist/dataprep-0.1.0-py3-none-any.whl
-      Processing ./dist/dataprep-0.1.0-py3-none-any.whl
-      Collecting pandas
-        Using cached pandas-1.3.4-cp39-cp39-macosx_10_9_x86_64.whl (11.6 MB)
+      $ python3 -m venv .venv
+      $ . .venv/bin/activate
+      $ python -m pip install dist/dataprep-0.1.0-cp313-cp313-macosx_13_0_arm64.whl
+      Processing ./dist/dataprep-0.1.0-cp313-cp313-macosx_13_0_arm64.whl
+      Collecting Cython (from dataprep==0.1.0)
+        Using cached Cython-3.0.11-py2.py3-none-any.whl.metadata (3.2 kB)
       …
-      Successfully installed dataprep-0.1.0 numpy-1.21.4 pandas-1.3.4 python-dateutil-2.8.2 pytz-2021.3 six-1.16.0
+      Successfully installed Cython-3.0.11 dataprep-0.1.0 numpy-2.1.2 pandas-2.2.3 python-dateutil-2.9.0.post0 pytz-2024.2 six-1.16.0 tzdata-2024.2
 
 .. tab:: Windows
 
    .. code-block:: console
 
       > mkdir test_env
       > cd test_env
-      > python -m venv .
-      > Scripts\activate.bat
-      > python -m pip install dist/dataprep-0.1.0-py3-none-any.whl
-      Processing ./dist/dataprep-0.1.0-py3-none-any.whl
-      Collecting pandas
-        Using cached pandas-1.3.4-cp39-cp39-macosx_10_9_x86_64.whl (11.6 MB)
+      > python -m venv .venv
+      > .venv\Scripts\activate.bat
+      > python -m pip install dist/dataprep-0.1.0-cp313-cp313-win_amd64.whl
+      Processing ./dist/dataprep-0.1.0-cp313-cp313-win_amd64.whl
+      Collecting Cython (from dataprep==0.1.0)
+        Using cached Cython-3.0.11-cp313-cp313-win_amd64.whl.metadata (3.2 kB)
       …
-      Successfully installed dataprep-0.1.0 numpy-1.21.4 pandas-1.3.4 python-dateutil-2.8.2 pytz-2021.3 six-1.16.0
+      Successfully installed Cython-3.0.11 dataprep-0.1.0 numpy-2.1.2 pandas-2.2.3 python-dateutil-2.9.0.post0 pytz-2024.2 six-1.16.0 tzdata-2024.2
 
 You can then check the :term:`Wheel` file with:
 
@@ -565,8 +565,8 @@ You can then check the :term:`Wheel` file with:
     $ mkdir test_env
     $ cd !$
     cd test_env
-    $ python3 -m venv .
-    $ source bin/activate
+    $ python3 -m venv .venv
+    $ . .venv/bin/activate
     $ python -m pip install dist/dataprep-0.1.0-py3-none-any.whl
     Processing ./dist/dataprep-0.1.0-py3-none-any.whl
     Collecting pandas

docs/libs/templating/features.rst

@@ -24,7 +24,7 @@ CookieCutter features
 
   .. code-block:: console
 
-    $ bin/python
+    $ python
     >>> from cookiecutter.main import cookiecutter
     >>> cookiecutter('.https://github.com/veit/cookiecutter-namespace-template.git')
     full_name [Veit Schiele]:

docs/libs/upload-install.rst

@@ -100,7 +100,7 @@ a new :term:`virtual environment` and install your package on *Test PyPI*:
 .. code-block:: console
 
     $ python3 -m venv test_env
-    $ source test_env/bin/activate
+    $ . test_env/bin/activate
     $ pip install -i https://test.pypi.org/simple/ minimal_example
 
 .. note::

docs/test/coverage.rst

@@ -32,13 +32,13 @@ You can create a report for the test coverage with Coverage.py.
 
    .. code-block:: console
 
-      $ bin/python -m pip install coverage pytest-cov
+      $ python -m pip install coverage pytest-cov
 
 .. tab:: Windows
 
    .. code-block:: ps1con
 
-      C:> Scripts\python -m pip install coverage pytest-cov
+      C:> python -m pip install coverage pytest-cov
 
 .. note::
    If you want to determine the test coverage for Python 2 and Python<3.6, you
@@ -54,8 +54,8 @@ The normal pytest output is followed by the coverage report, as shown here:
 .. code-block:: pytest
 
     $ cd /PATH/TO/items
-    $ python3 -m venv .
-    $ . bin/activate
+    $ python3 -m venv .venv
+    $ . .venv/bin/activate
     $ python -m pip install ".[dev]"
     $ pytest --cov=items
     ============================= test session starts ==============================
@@ -171,8 +171,8 @@ by executing coverage html after a previous coverage run:
 .. code-block:: console
 
     $ cd /PATH/TO/items
-    $ python3 -m venv .
-    $ . bin/activate
+    $ python3 -m venv .venv
+    $ . .venv/bin/activate
     $ python -m pip install ".[dev]"
     $ pytest --cov=items --cov-report=html
 

docs/test/doctest.rst

@@ -64,7 +64,7 @@ tests specified in a docstring are fulfilled.
 
       .. code-block:: console
 
-        C:> Scripts\python -m doctest arithmetic.py -v
+        C:> python -m doctest arithmetic.py -v
         Trying:
             add(7,6)
         Expecting:

docs/test/hypothesis.rst

@@ -12,27 +12,27 @@ fail and find bugs with little effort.
 
       .. code-block:: console
 
-         $ bin/python -m pip install hypothesis
+         $ python -m pip install hypothesis
 
    .. tab:: Windows
 
       .. code-block:: ps1con
 
-         C:> Scripts\python -m pip install hypothesis
+         C:> python -m pip install hypothesis
 
    Alternatively, Hypothesis can also be installed with extensions, for example:
 
    .. tab:: Linux/macOS
 
       .. code-block:: console
 
-         $ bin/python -m pip install hypothesis[numpy,pandas]
+         $ python -m pip install hypothesis[numpy,pandas]
 
    .. tab:: Windows
 
       .. code-block:: ps1con
 
-         C:> Scripts\python -m pip install hypothesis[numpy,pandas]
+         C:> python -m pip install hypothesis[numpy,pandas]
 
 #. Write a test:
 
@@ -56,7 +56,7 @@ fail and find bugs with little effort.
 
       .. code-block:: console
 
-           $ bin/python -m pytest test_hypothesis.py
+           $ python -m pytest test_hypothesis.py
            ============================= test session starts ==============================
            platform darwin -- Python 3.13.0, pytest-8.3.3, pluggy-1.5.0
            rootdir: /Users/veit/cusy/trn/python-basics/docs/test
@@ -96,7 +96,7 @@ fail and find bugs with little effort.
 
       .. code-block:: ps1con
 
-           C:> Scripts\python -m pytest test_hypothesis.py
+           C:> python -m pytest test_hypothesis.py
            ============================= test session starts ==============================
            platform win32 -- Python 3.13.0, pytest-8.3.3, pluggy-1.5.0
            rootdir: C:\Users\veit\python-basics\docs\test