1
1
A Simple Python Project Skeleton
2
2
================================
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.
7
9
8
10
.. _blog post : https://blog.jaraco.com/a-project-skeleton-for-python-projects/
9
11
13
15
14
16
A brand new project
15
17
-------------------
18
+
16
19
.. code-block :: bash
17
20
18
21
git init my-new-repo
@@ -26,6 +29,7 @@ From here, you can make the appropriate changes to the files for your specific p
26
29
27
30
Update an existing project
28
31
---------------------------
32
+
29
33
.. code-block :: bash
30
34
31
35
cd my-existing-project
@@ -41,22 +45,60 @@ More usage instructions can be found in ``docs/skeleton-usage.rst``.
41
45
Release Notes
42
46
=============
43
47
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
+
44
81
- 2023-07-18:
82
+
45
83
- Add macOS-13 job in azure-pipelines.yml
46
84
47
85
- 2022-03-04:
86
+
48
87
- Synchronize configure and configure.bat scripts for sanity
49
88
- Update CI operating system support with latest Azure OS images
50
89
- Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party dependencies
51
90
There are now fewer scripts. See etc/scripts/README.rst for details
52
91
53
92
- 2021-09-03:
93
+
54
94
- ``configure `` now requires pinned dependencies via the use of ``requirements.txt `` and ``requirements-dev.txt ``
95
+
55
96
- ``configure `` can now accept multiple options at once
56
97
- Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files
57
98
- Rename virtual environment directory from ``tmp `` to ``venv ``
58
99
- Update README.rst with instructions for generating ``requirements.txt `` and ``requirements-dev.txt ``,
59
100
as well as collecting dependencies as wheels and generating ABOUT files for them.
60
101
61
102
- 2021-05-11:
103
+
62
104
- Adopt new configure scripts from ScanCode TK that allows correct configuration of which Python version is used.
0 commit comments