Metadata-Version: 2.1
Name: publishtutorial
Version: 0.0.5
Summary: Hello!
Home-page: https://github.com/matteobollettino/publish_tutorial
Author: Matteo Bollettino
Author-email: matteo.bollettino@moxoff.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
Requires-Dist: meteostat ==1.6.5
Requires-Dist: pandas ==2.0.3
Provides-Extra: dev
Requires-Dist: check-manifest >=0.49 ; extra == 'dev'
Requires-Dist: pytest >=3.7 ; extra == 'dev'
Requires-Dist: twine >=4.0.2 ; extra == 'dev'

# Publish package tutorial

## Installation
Create a virtualenv and then install the library
```bash
pip3 install publishtutorial
```

## Usage
```python
from src.myfunc import say_hello, average
from src.second_script import second_function

# Generate "Hello, World!"
say_hello()

# Generate "Hello, Everybody!"
say_hello("Everybody")

# Compute average between two numbers (default values are 1 and 2 -> 1.5)
average()

# Compute average between two numbers (2.5)
average(2,3)

# Sum to input value the average between the input and 2 (default value is 1 -> 1 + average(1,2) = 2.5)
second_function()

# Sum to input value the average between the input and 2 (5.5)
second_function(3)
```

## Developing
To install publishtutorial,
 along with the tools you need to develop and run tests,
 run the following in your virtualenv:
```bash
# Clone the repo
$ git clone git@github.com:matteobollettino/publish_tutorial.git

# Install package, along with the tools you need to develop and run tests
$ pip3 install -e .[dev]

# Run the tests already present
$ pytest
```


Credits to: [Coding Tech](https://www.youtube.com/watch?v=GIF3LaRqgXo&t=3s) and [NeuralNine](https://www.youtube.com/watch?v=tEFkHEKypLI&t=2s)

