Giter VIP home page Giter VIP logo

getting-stated-with-own-python-package's Introduction

Making Your Own Python Package

The Python Package Index (PyPI) is a repository of software for the Python programming language. So all python packages are stored in PyPi

Create the files in the following order

packaging_tutorial
  |--- LICENSE
  |--- README.md
  |--- example_pkg
              |--- _init_.py
  |--- setup.py
  |--- tests

Write yout functions in the _init_.py file.

Example:

def name():
    print("My name is "......" ")

  Open setup.py and paste the code. ( variables with ###...### need to be changed ) (Enter a Unique Package name)

import setuptools

with open("README.md", "r", encoding="utf-8") as fh:
    long_description = fh.read()

setuptools.setup(
    name=" example-pkg-(### Package Name ###) ", # Replace with your own username
    version="0.0.1",
    author=" (###Your name###) ",
    author_email=" (###Your email###) ",
    description=" (###Description about your package###) ",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/pypa/sampleproject",
    packages=setuptools.find_packages(),
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    python_requires='>=3.6',
)

  Put description about your file in README.md file (using Markdown)

# Example Package
This is a simple example package.

Creating LICENSE.   (Replace [year] [fulname] with your details ).

MIT License

Copyright (c) [year] [fullname]

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.

  Open cmd in packaging_tutorial folder and run the commands.

py -m pip install --user --upgrade setuptools wheel

py setup.py sdist bdist_wheel

  The following files will be created after runnimg the commands.

dist     |---example_pkg_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl     |---example_pkg_YOUR_USERNAME_HERE-0.0.1.tar.gz

Uploading the Packages

First create an account at Pypi.

Now create a PyPl API token. Open command prompt from folder packaging_tutorial and execute these commands.  

py -m pip install --user --upgrade twine

python3 -m twine upload --repository testpypi dist/*

Enter your username and password to upload the package.

You uploaded your package😀.

After uploading you can look at your repository at https://test.pypi.org/project/Your package name

Download in cmd

python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-pkg-YOUR-USERNAME-HERE

  Now you can open python

import example_pkg

getting-stated-with-own-python-package's People

Contributors

reach-the-sky avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.