semvec/pypi-packages huggingface dataset:
firstpctpypi 0.0.1
First package - PyPI.org
License: MIT License
Keywords: First package Almaviva do Brasil

# First package with publish into PyPI.org
> id do projeto: firstpctpypi

## Getting Started
### Dependencies
You need Python 3.8.2 or later to use **firstpctpypi**. You can find it at [python.org](https://www.python.org/).
You also need setuptools, wheel and twine packages, which is available from [PyPI](https://pypi.org). If you have pip, just run:
```
pip install setuptools
pip install wheel
pip install twine
```

### Installation
Clone this repo to your local machine using:
```
gh repo clone Almaviva-do-Brasil/firstpctpypi
```

## Features
- File structure for PyPI packages
- Setup with package informations
- License example

## Instructions
> Initially, you need to create an account on the [PyPI](https://pypi.org/) and [Test PyPI](https://test.pypi.org/) websites. The Test PyPI site is made available precisely so that we can test the submissions we want to make in the future. Remember your login and password well, they will be needed when we go to submit the package.

1. To create the package that will be sent to PyPI, it will be necessary to run the setup.py file passing it as “sdist” parameter. From the terminal, navigate to the folder where the setup.py file is located and use the following command:
```
python setup.py sdist
```

2. A folder named "dist" will be created with ".tar.gz" files, which contains the package to be submitted.

3. Test repository: Finally, just upload the package generated in the “dist” folder. However, it is interesting to first upload it to the PyPI repository test site. This way, you don't disturb the versioning of the official repository and you can check if everything is working as desired. To do this, run the twine upload command informing the Test PyPI API URL:
```
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

4. Official repository: To upload your package to the official repository, just run the same command used above, but without informing any URL as a parameter. Here you will be asked for your official repository login and password.
```
twine upload dist/*
```

5. Now we are going to install and use our package. To install the package that is in the official repository just use the pip in the conventional way. The name of the package created here is "firstpctpypi", to install it just run:
```
pip install firstpctpypi
```

6. To install the package available on Test PyPI, include the API URL:
```
pip install -i https://test.pypi.org/simple/ firstpctpypi
```

**To use, include**
```
from firstpctpypi import modulo
modulo.teste()
```

**Result**
```
>>> from firstpctpypi import modulo
>>> modulo.teste()
[5 6 7 8 9]
Seu primeiro pacote publicado no PyPI esta funcionando...
```

To more details, visit [Packaging Python Projects Site](https://packaging.python.org/tutorials/packaging-projects/#uploading-your-project-to-pypi)