Long_description_content_type='text/markdown', With open('README.md', 'r', encoding='utf-8') as fh:Īuthor='Deniz Kenan deployment of python packaging tutorial', You can set the version number you want in the “ setup” function by using the “ version” option manually for your package. The sample “ pyproject.toml” should look like: įurthermore, setup configurations need to be set by “ setup.py” and “ setup.cfg”. For instance, we write the following: numpy In the “ requirements.txt” file we indicate the dependencies. Self.assertEqual(method_1, 'Method 1!') if _name_ = '_main_': import unittestįrom src.example_folder_1.example_folder_2.example_folder_3.example_folder_4 import example Then test cases are described in “ example_test.py”. In “ example.py” the methods are defined as we mentioned.

In this part, we handle the contents of the files we mentioned above in general. Configuration Files, Dependencies, and Other Files these files indicate the address of the modules we will add.Īll test subjects related to the package are located in the “ example_test.py” file in the “ tests/” folder. The _init_.py files are used to import modules from related folders, i.e. Details of created methods and Python codes take place in “ example.py”. In the above structure, the number of “ example_folder_x” folders can vary according to your application in the “ src/” folder. On the “ Packaging and distributing projects” page it is stated that “ setup.cfg is an ini file that contains option defaults for setup.py commands.” We list the specific versions of all the dependencies in “ requirements.txt” to be installed by pip.ĭifferent sides of the Python project are configured and several packaging options are determined by “ setup.py” and “ setup.cfg”. Significant information about the project like user guide, maintaining, contributions, etc. The “ pyproject.toml” describes the build system requirements of Python projects. gitlab-ci.yml” one can define other configuration files, dependencies, caches, jobs, the location to deploy the application to, how to trigger the jobs, etc. gitlab-ci.yml” configuration file is required to employ GitLab CI/CD. gitignore” is a regular file defining the files that Git has to ignore. We specify how we want to license our project with the content of the classic “ LICENSE” file. You will find the explanation of each file in a sample Python project folder you want to pack. In this article, I’ll show you how to create a Python package step by step with the help of GitLab CI/CD. Simply put, the Python package is created by defining a hierarchical directory structure with necessary files for a Python application which covers modules and sub-packages. Moreover, modules and methods can be used in a practical way. Besides encapsulation, you supply a reusable project and make others not write the same codes again. So, it is time to create Python packages in accordance with the needs of others that will be used. You need to ensure the sources are encapsulated. Sometimes, you don’t want customers, teammates, and others to reach the source code of the Python project that you create.

Edge pipeline tech support