Skip to content

Commit 205e080

Browse files
authored
Update README.md
1 parent 88b8ae3 commit 205e080

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,60 @@
11
# Auto-Python-Pack
22
A tiny tool that converts python code to packages (modules) using your setup.py file
3+
4+
Go to [releases](https://github.com/neek8044/Auto-Python-Pack/releases) and download the latest version
5+
6+
## Use
7+
### Step 1
8+
**Create a setup.py**
9+
<br>
10+
Example:
11+
```
12+
from setuptools import setup, find_packages
13+
14+
NAME = 'Local folder to pack'
15+
AUTHOR = 'Your full name'
16+
URL = 'https://github.com/your_username/your_repo'
17+
18+
VERSION = '0.2.5'
19+
DESCRIPTION = 'A python package'
20+
LONG_DESCRIPTION = 'A longer description of the python package'
21+
22+
##############################
23+
# Leave the following as is: #
24+
setup(
25+
name = NAME,
26+
version = VERSION,
27+
author = AUTHOR,
28+
url = URL,
29+
description = DESCRIPTION,
30+
long_description = LONG_DESCRIPTION,
31+
packages = find_packages(),
32+
33+
# #
34+
##############################
35+
36+
# You may want to change those:
37+
38+
classifiers = [
39+
"Development Status :: Alpha",
40+
"Operating System :: OS Independent",
41+
"Programming Language :: Python :: 3"
42+
]
43+
)
44+
```
45+
46+
### Step 2
47+
Place pack.exe in the same folder as setup.py
48+
<br>
49+
setup.py should be under the root of the project to locate the folder as said above in the example.
50+
51+
### Step 3
52+
Launch pack.exe
53+
It may show a warning that it is malware/virus or similar stuff. It is completely safe though. If you still do not trust it, you can inspect pack.py and after being sure it is safe, copy it in the same folder as setup.py, then run it.
54+
55+
## Now what?
56+
In the folder you are currently at, there sould have been created three more folders: dist, build, and egg-info.
57+
<br>
58+
To find your packages, go under dist and you sould see two files: a '.whl' (wheel) and a '.tar.gz' (compressed)
59+
60+
**You can now publish your pack to [pypi.org](https://pypi.org/)**

0 commit comments

Comments
 (0)