Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
yunfzhou committed Feb 5, 2024
0 parents commit e05a2e2
Show file tree
Hide file tree
Showing 7 changed files with 74 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dist/
*.egg-info/
__pycache__/
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 The Python Packaging Authority

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## pypkg_tutorial

- This is a simple package tutorial.
- The full tutorial can be found at https://makeoptim.com/python/pypi-pkg

### How to install

```
python -m pip install --index-url https://test.pypi.org/simple/ --no-deps pypkg_tutorial
```

### How to use

```python
from pypkg_tutorial import hello

hello.hello_world()
```

Output:

```
Hello, world!
```
1 change: 1 addition & 0 deletions pypkg_tutorial/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
name = "pypkg_tutorial"
2 changes: 2 additions & 0 deletions pypkg_tutorial/hello.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def hello_world():
print("Hello, world!")
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[build-system]
requires = [
"setuptools>=42",
"wheel"
]
build-backend = "setuptools.build_meta"
17 changes: 17 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[metadata]
name = pypkg_tutorial
version = 0.0.1
author = yunfzhou
author_email = [email protected]
description = A tutorial for building a Python package
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/yunfzhou/pypkg_tutorial
classifiers =
Programming Language :: Python :: 3
License :: OSI Approved :: MIT License
Operating System :: OS Independent

[options]
packages = find:
python_requires = >=3.6

0 comments on commit e05a2e2

Please sign in to comment.