Skip to content

Commit e15a81e

Browse files
minor documentation edits
1 parent 5f1d134 commit e15a81e

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pip3 install PythonStarterPackage
1212
## Usage
1313
After installation, you can run this app in your terminal with this command:
1414
```
15-
PythonStarterPackage
15+
pythonstarterpackage
1616
```
1717
You can also run it with ```python3 -m```:
1818
```

doc/PythonStarterPackage Setup Guide.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ classifiers =
3636
Programming Language :: Python :: 3 :: Only
3737
Programming Language :: Python :: 3.8
3838
```
39+
* ```version``` - Follows the convention: major.minor.maintenance
40+
* ```classifiers``` - See https://pypi.org/classifiers/ for list of classifiers.
41+
* Deployment status classifiers:
42+
```
43+
Development Status :: 3 - Alpha
44+
Development Status :: 4 - Beta
45+
Development Status :: 5 - Production/Stable
46+
```
47+
3948
2. ```[options]``` - This section contains the critical configurations that tells setuptools what dependencies the package has, which python version the package requires, where to find the package, etc.
4049
```
4150
[options]
@@ -49,23 +58,27 @@ packages = find:
4958
* ```python_requires = >=3.8``` - Python version required to run your package.
5059
* ```package_dir = =src``` - This is the source directory of your package.
5160
* ```packages = find:``` - This is the key command that tells setuptools to find the resources of your package.
61+
5262
3. ```[options.packages.find]``` - Allows you to specify where you want ```packages = find:``` to find your resources.
5363
```
5464
[options.packages.find]
5565
where = src
5666
```
67+
5768
4. ```[options.entry_points]``` - This is where you define the entry points to your app. See this guide for more on entry points: https://setuptools.pypa.io/en/stable/userguide/entry_point.html
5869
```
5970
[options.entry_points]
6071
console_scripts =
6172
PythonStarterPackage = pythonstarterpackage.main:main
6273
```
74+
6375
5. ```[options.package_data]``` - This defines files located inside your package that should be included in the build. Things like app assets, environmental variables, photos, etc.
6476
```
6577
[options.package_data]
6678
data =
6779
data/*.json
6880
```
81+
6982
6. ```[options.data_files]``` - This defines the files located outside your package that should be included in the build. Things like configurations, message catalogs, external data, sample data, etc.
7083
```
7184
[options.data_files]

0 commit comments

Comments
 (0)