Skip to content

Commit

Permalink
New version is released now
Browse files Browse the repository at this point in the history
  • Loading branch information
Souvic committed Jul 4, 2021
1 parent 2caaed6 commit c59731e
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 9 deletions.
Binary file modified dist/pypacklib-0.0.1-py3-none-any.whl
Binary file not shown.
Binary file modified dist/pypacklib-0.0.1.tar.gz
Binary file not shown.
62 changes: 53 additions & 9 deletions src/pypacklib.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Metadata-Version: 2.1
Name: pypacklib
Version: 0.0.1
Summary: Provides a basic package structure
Summary: One command simplest way to make and upload a python package!
Home-page: https://github.com/Souvic/pypacklib.git
Author: Souvic Chakraborty
Author-email: chakra.souvic@gmail.com
Expand All @@ -15,7 +15,7 @@ Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Makes _something_ easy again!
# Single command for python package creation from one/multiple .py files ( _Make packaging fun again!_ )
[![License: MIT](https://img.shields.io/github/license/Souvic/pypacklib)](https://opensource.org/licenses/MIT)
[![stars](https://img.shields.io/github/stars/Souvic/pypacklib)]()
[![Github All Releases](https://img.shields.io/github/downloads/Souvic/pypacklib/total.svg)]()
Expand All @@ -35,9 +35,19 @@ License-File: LICENSE
[![Buy Me A Coffee](https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png)](https://www.buymeacoffee.com/Souvic)


Some appreciatory description
- [x] Lightweight
- [x] Easiest to use
Most of the packages are simple and a collection of few functions or classes.
We have created a package for that now that can create python packages, upload to github and distribute to pypi all in a single call.
We collect desired packagename, author name and a few info interactively and create the package from a single python file.
You can use multiple python scripts too.
To use multiple scripts give a space seperated list when asked for file locations with main file (the file where all the functions and classes you want user to use is present) at the start.
For simple packaging, one single file is enough.
- [x] Supports python 3.6+
- [x] Autopopulates setup files, README.md and version etc , uploads to GitHub and PyPI
- [x] Easily Customizable
- [x] Easiest to use with only single interactive command
- [ ] 1 min video tutorial

> Fun part: This package is also created by running the script located at src/pypacklib/\_\_main\_\_.py

## Install from PyPi
```
Expand All @@ -49,15 +59,49 @@ pip3 install pypacklib
pip3 install git+https://github.com/Souvic/pypacklib.git
```

# Example usage!
Use it like this..
# One command to create/upload/update them all!
Easy-to-follow prompts will guide you through the process
```
pypack
```
# Unnecessary detailed instructions (just see the 1 min video)

### To make a new package and upload to github from a some/one python file(s):
1. Run the command _pypack_ (and just follow the interactive framework forgetting the lines\[2,3,4\] written below)
2. Input yes at the first prompt as you will be questioned.
3. Follow the instructions that will appear.
4. Make necessary changes if you have to (e.g. updating README.md file) now on the github repo before submitting to PyPi(by following the upload instruction below)


### To update/upload a package to PyPi which already has a GitHub repo:
1. Make all necessary changes in the python files(location: src/packagename/) in the github repo.
2. Run the command _pypack_ (and just follow the interactive framework forgetting the lines\[2,3,4\] written below)
3. Input no at the first prompt.
4. Follow the instructions that will appear.

# Extras to save GitHub and PyPI passtokens (save typing time)

### Set up your $HOME/.pypirc file with the passtoken like this to save twine password to avoid typing username and password everytime [Doc Link](https://twine.readthedocs.io/en/latest/#keyring-support)
Create $HOME/.pypirc and paste the below code replacing only _yourpasstoken
```
cmpp
[pypi]
username = __token__
password = yourpasstoken
```

### Use git store password utility to avoid typing GitHub username and password everytime [Doc Link](https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage)
Paste the below code for that with your passtoken and username
```
git credential-store --file ~/.mysecretfilelocation store
protocol=https
host=github.com
username=yourusername
password=passtoken
```
## Important note:
You can use
[Github-flavored Markdown](https://guides.github.com/features/mastering-markdown/)
to write your content.
to write your content for your README.md



2 changes: 2 additions & 0 deletions src/pypacklib.egg-info/SOURCES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ src/pypacklib/__main__.py
src/pypacklib.egg-info/PKG-INFO
src/pypacklib.egg-info/SOURCES.txt
src/pypacklib.egg-info/dependency_links.txt
src/pypacklib.egg-info/entry_points.txt
src/pypacklib.egg-info/requires.txt
src/pypacklib.egg-info/top_level.txt
3 changes: 3 additions & 0 deletions src/pypacklib.egg-info/entry_points.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[console_scripts]
pypack = pypacklib:main

4 changes: 4 additions & 0 deletions src/pypacklib.egg-info/requires.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
build>=0.5
virtualenv>=20.4.7
pipreqs>=0.4.10
twine>=3.4.1

0 comments on commit c59731e

Please sign in to comment.