From b10edb55eb35e28798b2c1809e94b9e301482dd2 Mon Sep 17 00:00:00 2001 From: nicolalandro Date: Sat, 13 Nov 2021 15:18:04 +0100 Subject: [PATCH] add setup.py correct --- .gitignore | 10 ++++++++-- README.md | 4 ++-- obj2html/__init__.py | 1 + {src => obj2html}/obj2html.py | 0 setup.cfg | 2 ++ setup.py | 25 +++++++++++++++++++++++++ src/__init__.py | 0 test/test_obj2html.py | 2 +- 8 files changed, 39 insertions(+), 5 deletions(-) create mode 100644 obj2html/__init__.py rename {src => obj2html}/obj2html.py (100%) create mode 100644 setup.cfg delete mode 100644 src/__init__.py diff --git a/.gitignore b/.gitignore index d852427..7e09b58 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,11 @@ -__pycache__ -venv .idea +venv + +__pycache__ .pyc + .coverage + +MANIFEST +dist +build diff --git a/README.md b/README.md index 6025a10..d2ad356 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - [![pipeline status](https://gitlab.com/nicolalandro/obj2html/badges/main/pipeline.svg)](https://gitlab.com/nicolalandro/obj2html/-/commits/main) +[![pipeline status](https://gitlab.com/nicolalandro/obj2html/badges/main/pipeline.svg)](https://gitlab.com/nicolalandro/obj2html/-/commits/main) [![coverage report](https://gitlab.com/nicolalandro/obj2html/badges/main/coverage.svg)](https://gitlab.com/nicolalandro/obj2html/-/commits/main) # Obj2Html @@ -40,7 +40,7 @@ python3.8 -m coverage report -m In this chapter I add at least a link for each of the knowledge needed for develop this project. * python * git -* how to use setup.py +* [how to write a setup.py](https://medium.com/@joel.barmettler/how-to-upload-your-python-package-to-pypi-65edc5fe9c56) * python test * coverage * gitlab ci/cd diff --git a/obj2html/__init__.py b/obj2html/__init__.py new file mode 100644 index 0000000..8433851 --- /dev/null +++ b/obj2html/__init__.py @@ -0,0 +1 @@ +from .obj2html import obj2html \ No newline at end of file diff --git a/src/obj2html.py b/obj2html/obj2html.py similarity index 100% rename from src/obj2html.py rename to obj2html/obj2html.py diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..224a779 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +description-file = README.md \ No newline at end of file diff --git a/setup.py b/setup.py index e69de29..9b1f005 100644 --- a/setup.py +++ b/setup.py @@ -0,0 +1,25 @@ +from distutils.core import setup +setup( + name = 'obj2html', # How you named your package folder (MyLib) + packages = ['obj2html'], # Chose the same as "name" + version = '0.1', # Start with a small number and increase it with every change you make + license='MIT', # Chose a license from here: https://help.github.com/articles/licensing-a-repository + description = 'TYPE YOUR DESCRIPTION HERE', # Give a short description about your library + author = 'Nicola Landro', # Type in your name + author_email = 'nicolaxx94@live.it', # Type in your E-Mail + url = 'https://gitlab.com/nicolalandro/obj2html', # Provide either the link to your github or to your website + download_url = 'https://github.com/user/reponame/archive/v_01.tar.gz', # I explain this later on + keywords = ['3D', '.obj', '.html','jupyter', ''], # Keywords that define your package best + install_requires=[], + classifiers=[ + 'Development Status :: 5 - Alpha', # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package + 'Intended Audience :: Developers', # Define that your audience are developers + 'Topic :: Software Development :: Build Tools', + 'License :: OSI Approved :: MIT License', # Again, pick a license + 'Programming Language :: Python :: 3', #Specify which pyhton versions that you want to support + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + ], +) \ No newline at end of file diff --git a/src/__init__.py b/src/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/test/test_obj2html.py b/test/test_obj2html.py index df7b9cc..a822046 100644 --- a/test/test_obj2html.py +++ b/test/test_obj2html.py @@ -1,5 +1,5 @@ import unittest -from src.obj2html import obj2html +from obj2html import obj2html import os class TestObj2Html(unittest.TestCase):