How to Create and upload Python package to pypi

 First, create a python project. I assume that you all are already familiar with python and python environment creation so I not gonna talk about it. This post is using a real project (simple)  as the demo with PyCharm IDE.


After creating the project in the project file list there create a file name "setup.cfg" (extension is cfg).

The content is like below.

[metadata]
name = geometric-open-street-map-api
version = 0.0.1
author = kyorilys
author_email = kyorilys_256@live.com
description = Geometric Open Street Map to get latitude and longitude and distance between two point and route optimizations
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/kyorilys/GeometricApi
project_urls =
    Bug Tracker = https://github.com/kyorilys/GeometricApi/issues
classifiers =
    Programming Language :: Python :: 3
    License :: OSI Approved :: MIT License
    Operating System :: OS Independent

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

[options.packages.find]
where = src

As you can see:

1st parameter is the name, this is the name that you will use on the pip.

2nd is the version number quite significant also seems that it can't update to PyPI if the version is the same.

3rd is the author's name ... (sounds like didn't explain)

4th email =|

5th is the description that will show the picture below. 

6th is the long description which will get it from the README.md file.

7th is the format of the long description. not sure got what other type. but here is using markdown.

8th is the URL ... ..... 

9th is the project URLs.........

10th is the classifiers. 

and lastly  "where" is needed to the PyPI where to find the packages.


After that create a file called README.md can be another name but normally we call this, with the content as below.

# GEOMETRIC API 
Python Geometric Place latitude and longitude

Currently, only will have one function which are convert address to lat lng


You just need call the function as the following:

    TEMPORARY EMPTY


The next step is to add pyproject.toml

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"


After this you can build and upload the package to PyPI
1) install the require build tools:
    pip install build twine
2) Build the package:
    python -m build
3) Upload the package to PyPI
    twine upload dist/*

Lastly you can install and test the package locally.

pip install geometric-open-street-map-api



from geometric_api.geolocation import GeometricAPI

latlng = GeometricAPI.address_to_latlng("1600 Amphitheatre Parkway, Mountain View, CA")
print(f"Latitude, Longitude: {latlng}")

Now, your package is live on PyPI and ready to be used! 


Comments

Post a Comment

Popular posts from this blog

Reading and Writing Operation of SRAM

Image
The diagram below is illustrate Static Random Access Memory (SRAM)Cell for the explanation. SRAM cell is make up of 2 inverters are cross-connected to form a latch .The latch is connected to 2 bit line by transistor T1 and T2 . T1 and T2 can switch opened or closed under control of word line.When word line is ground level, the transistors are turned off and the latch retrains its state. During the Read Operation ,Word line is activated to close switches T1 and T2 . If the cell is in state 1; the signal on b line is high and the signal on b’ line is low.The opposite is true if the cell is in state 0.Thus, b and b’ are always complements of each other’s. The sense /write circuit at the end of the two bit line monitors their state and sets the corresponding output accordingly. While in Write Operation ,the Sense/Write circuit drives bit lines b and b’, instead of sensing their state.It places the appropriate value on bit line b and its complement on b’ and activate the word ...
Read more

Reading & Writing Operation of DRAM

Image
In Dynamic Random Access Memory CELL , transistor acts as a switch to Close (allowing current to flow) when voltage applied in address line or Open (no current flow) when no voltage applied in address line.Address Line also known as word line .Which use to signal the transistor to close or open. During the Write operation ,a voltage is applied on the bit line and a signal applied to the address line to close the transistor.Then the voltage applied on the bit line will transfer to capacitor and store in the capacitor However the capacitor has tendency to discharge and has to refresh to maintain the bit. While in Reading Operation ,the instruction find the bit store using the address line to read the data or bit. When the address line is selected ,the transistor turns on and the charge stored on the capacitor is fled out onto a bit line and to sense amplifier. Sense amplifiers compare the capacitor voltage to reference value to determine the logic 1 or logic 0.The read out from ...
Read more

Method to Convert from Stream to Json C#

Recently I was using the C# HttpClient to make REST request but I found that is was quite troublesome so I have changed to using HttpWebRequest instead. So want the HttpWebRequest result is return it was in Stream form. I not able to convert it into Json. this is the method i convert the stream to JSON. HttpWebResponse response = ( HttpWebResponse ) requirejs . GetResponse (); Stream stream = response . GetResponseStream (); StreamReader sr = new StreamReader ( stream ); var serializer = new System . Web . Script . Serialization . JavaScriptSerializer (); var jsonObject = serializer . DeserializeObject ( sr . ReadToEnd ()); As you can see that jsonObject is an object. Now you can parse it into the Json(JsonObject); If you have any question can leave a comment below.
Read more