11A Simple Python Project Skeleton
22================================
3- This repo attempts to standardize the structure of the Python-based project's
4- repositories using modern Python packaging and configuration techniques.
5- Using this `blog post `_ as inspiration, this repository serves as the base for
6- all new Python projects and is mergeable in existing repositories as well.
3+
4+ This repo attempts to standardize the structure of the Python-based project's repositories using
5+ modern Python packaging and configuration techniques that can then be applied to many repos.
6+
7+ Using this `blog post `_ as inspiration, this repository serves as the base for all new Python
8+ projects and is mergeable in existing repositories as well.
79
810.. _blog post : https://blog.jaraco.com/a-project-skeleton-for-python-projects/
911
1315
1416A brand new project
1517-------------------
18+
1619.. code-block :: bash
1720
1821 git init my-new-repo
@@ -26,6 +29,7 @@ From here, you can make the appropriate changes to the files for your specific p
2629
2730Update an existing project
2831---------------------------
32+
2933.. code-block :: bash
3034
3135 cd my-existing-project
@@ -41,22 +45,60 @@ More usage instructions can be found in ``docs/skeleton-usage.rst``.
4145Release Notes
4246=============
4347
48+ - 2025-03-29:
49+
50+ - Add support for beta macOS-15
51+ - Add support for beta windows-2025
52+
53+ - 2025-02-14:
54+
55+ - Drop support for Python 3.8, add support in CI for Python 3.13, use Python 3.12 as default
56+ version.
57+
58+ - 2025-01-17:
59+
60+ - Drop support for macOS-12, add support for macOS-14
61+ - Add support in CI for ubuntu-24.04
62+ - Add support in CI for Python 3.12
63+
64+ - 2024-08-20:
65+
66+ - Update references of ownership from nexB to aboutcode-org
67+
68+ - 2024-07-01:
69+
70+ - Drop support for Python 3.8
71+ - Drop support for macOS-11, add support for macOS-14
72+
73+ - 2024-02-19:
74+
75+ - Replace support in CI of default ubuntu-20.04 by ubuntu-22.04
76+
77+ - 2023-10-18:
78+
79+ - Add dark mode support in documentation
80+
4481- 2023-07-18:
82+
4583 - Add macOS-13 job in azure-pipelines.yml
4684
4785- 2022-03-04:
86+
4887 - Synchronize configure and configure.bat scripts for sanity
4988 - Update CI operating system support with latest Azure OS images
5089 - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party dependencies
5190 There are now fewer scripts. See etc/scripts/README.rst for details
5291
5392- 2021-09-03:
93+
5494 - ``configure `` now requires pinned dependencies via the use of ``requirements.txt `` and ``requirements-dev.txt ``
95+
5596 - ``configure `` can now accept multiple options at once
5697 - Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files
5798 - Rename virtual environment directory from ``tmp `` to ``venv ``
5899 - Update README.rst with instructions for generating ``requirements.txt `` and ``requirements-dev.txt ``,
59100 as well as collecting dependencies as wheels and generating ABOUT files for them.
60101
61102- 2021-05-11:
103+
62104 - Adopt new configure scripts from ScanCode TK that allows correct configuration of which Python version is used.
0 commit comments