api-24sea 0.2.2__tar.gz → 0.2.4__tar.gz

{api_24sea-0.2.2 → api_24sea-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: api_24sea
-Version: 0.2.2
+Version: 0.2.4
 Summary: The `api_24sea` package contains modules that are aimed at helping a user interact with the 24SEA API.
 Author-email: Pietro D'Antuono <pietro.dantuono@24sea.eu>
 Maintainer-email: Pietro D'Antuono <pietro.dantuono@24sea.eu>
@@ -10,7 +10,7 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Science/Research
 Classifier: Intended Audience :: Information Technology
-Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Natural Language :: English
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3
@@ -21,8 +21,8 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Database
 Requires-Dist: pandas
-Requires-Dist: requests>=2.32.3
-Requires-Dist: pydantic>=2.8.2
+Requires-Dist: requests
+Requires-Dist: pydantic>=2
 Requires-Dist: sphinx ; extra == "docs"
 Requires-Dist: sphinx_design ; extra == "docs"
 Requires-Dist: autoclasstoc ; extra == "docs"
@@ -67,30 +67,15 @@ Provides-Extra: test
 pip install api_24sea
 ```
 
-## Project Structure
+## DataSignals Usage
 
-```shell
-.
-├── .azure/
-├── api_24sea/
-│   ├── __init__.py
-│   ├── datasignals/
-│   │   ├── __init__.py
-│   │   └── schemas.py
-│   ├── utils.py
-│   └── version.py
-├── tests/
-├── docs/
-├── notebooks/
-├── pyproject.toml
-├── LICENSE
-├── VERSION
-└── README.md
-```
 
-## DataSignals Usage
+The following example shows the classical usage of the datasignals module.
 
-The following example shows the classical usage of the datasignals module. The first step is to import the package and the necessary libraries. Then, the environment variables are loaded from a `.env` file. After that, the package is initialized and the user is authenticated with the API. Finally, the user can get data from the API.
+* The first step is to import the package and the necessary libraries.
+* Then, the environment variables are loaded from a `.env` file.
+* After that, the package is initialized and the user is authenticated with the API.
+* Finally, the user can get data from the API.
 
 ### Importing the package
 ```python
@@ -110,6 +95,29 @@ import api_24sea
 ```
 
 ### Setting up the environment variables
+
+This step assumes that you have a file structure similar to the following one:
+
+```shell
+.
+├── env/
+│   └── .env
+├── notebooks/
+│   └── example.ipynb
+└── requirements.txt
+```
+
+The `.env` file should look like this:
+
+```shell
+API_USERNAME=your_username
+API_PASSWORD=your_password
+```
+
+
+With this in mind, the following code snippet shows how to load the environment
+variables from the `.env` file:
+
 ```python
 # %%
 _ = dotenv.load_dotenv("../env/.env")
@@ -121,6 +129,10 @@ else:
 ```
 
 ### Initializing an empty dataframe
+
+Initializing an empty dataframe is necessary to use the API, as here is
+where the data will be stored.
+
 ```python
 # %%
 df = pd.DataFrame()
@@ -134,20 +146,32 @@ except Exception as e:
 ```
 
 ### Authenticating with the API
+
+The authentication step allows the user to access the API and check the
+available metrics.
+
 ```python
 # %%
 df.datasignals.authenticate(
     os.getenv("API_USERNAME"), os.getenv("API_PASSWORD")
 )
+# After authentication, the user can access the API
 ```
 
 ### Checking the available metrics after authentication
 ```python
 # %%
 df.datasignals.metrics_overview
+# It will show all the available metrics with the corresponding units
+# and the time window for which the user is allowed to get data
 ```
 
 ### Getting sample data from the API
+
+After loading the environment variables and authenticating with the API,
+the user can get data from [24SEA API endpoints](https://api.24sea.eu/redoc/v1/).
+
+
 ```python
 # %%
 sites = ["windfarm"]
@@ -175,3 +199,28 @@ df.datasignals.selected_metrics
 df
 ```
 
+## Project Structure
+
+```shell
+.
+├── .azure/
+├── api_24sea/
+│   ├── __init__.py
+│   ├── datasignals/
+│   │   ├── __init__.py
+│   │   └── schemas.py
+│   ├── utils.py
+│   └── version.py
+├── tests/
+├── docs/
+├── notebooks/
+├── pyproject.toml
+├── LICENSE
+├── VERSION
+└── README.md
+```
+
+## License
+
+The package is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
+

{api_24sea-0.2.2 → api_24sea-0.2.4}/README.md

@@ -8,30 +8,15 @@
 pip install api_24sea
 ```
 
-## Project Structure
+## DataSignals Usage
 
-```shell
-.
-├── .azure/
-├── api_24sea/
-│   ├── __init__.py
-│   ├── datasignals/
-│   │   ├── __init__.py
-│   │   └── schemas.py
-│   ├── utils.py
-│   └── version.py
-├── tests/
-├── docs/
-├── notebooks/
-├── pyproject.toml
-├── LICENSE
-├── VERSION
-└── README.md
-```
 
-## DataSignals Usage
+The following example shows the classical usage of the datasignals module.
 
-The following example shows the classical usage of the datasignals module. The first step is to import the package and the necessary libraries. Then, the environment variables are loaded from a `.env` file. After that, the package is initialized and the user is authenticated with the API. Finally, the user can get data from the API.
+* The first step is to import the package and the necessary libraries.
+* Then, the environment variables are loaded from a `.env` file.
+* After that, the package is initialized and the user is authenticated with the API.
+* Finally, the user can get data from the API.
 
 ### Importing the package
 ```python
@@ -51,6 +36,29 @@ import api_24sea
 ```
 
 ### Setting up the environment variables
+
+This step assumes that you have a file structure similar to the following one:
+
+```shell
+.
+├── env/
+│   └── .env
+├── notebooks/
+│   └── example.ipynb
+└── requirements.txt
+```
+
+The `.env` file should look like this:
+
+```shell
+API_USERNAME=your_username
+API_PASSWORD=your_password
+```
+
+
+With this in mind, the following code snippet shows how to load the environment
+variables from the `.env` file:
+
 ```python
 # %%
 _ = dotenv.load_dotenv("../env/.env")
@@ -62,6 +70,10 @@ else:
 ```
 
 ### Initializing an empty dataframe
+
+Initializing an empty dataframe is necessary to use the API, as here is
+where the data will be stored.
+
 ```python
 # %%
 df = pd.DataFrame()
@@ -75,20 +87,32 @@ except Exception as e:
 ```
 
 ### Authenticating with the API
+
+The authentication step allows the user to access the API and check the
+available metrics.
+
 ```python
 # %%
 df.datasignals.authenticate(
     os.getenv("API_USERNAME"), os.getenv("API_PASSWORD")
 )
+# After authentication, the user can access the API
 ```
 
 ### Checking the available metrics after authentication
 ```python
 # %%
 df.datasignals.metrics_overview
+# It will show all the available metrics with the corresponding units
+# and the time window for which the user is allowed to get data
 ```
 
 ### Getting sample data from the API
+
+After loading the environment variables and authenticating with the API,
+the user can get data from [24SEA API endpoints](https://api.24sea.eu/redoc/v1/).
+
+
 ```python
 # %%
 sites = ["windfarm"]
@@ -115,3 +139,28 @@ df.datasignals.selected_metrics
 # %%
 df
 ```
+
+## Project Structure
+
+```shell
+.
+├── .azure/
+├── api_24sea/
+│   ├── __init__.py
+│   ├── datasignals/
+│   │   ├── __init__.py
+│   │   └── schemas.py
+│   ├── utils.py
+│   └── version.py
+├── tests/
+├── docs/
+├── notebooks/
+├── pyproject.toml
+├── LICENSE
+├── VERSION
+└── README.md
+```
+
+## License
+
+The package is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).

{api_24sea-0.2.2 → api_24sea-0.2.4}/api_24sea/version.py

@@ -19,7 +19,7 @@ Attributes:
 import re
 from typing import NamedTuple, Optional
 
-__version__: str = "0.2.2"
+__version__: str = "0.2.4"
 
 _REGEX = "".join(
     [

{api_24sea-0.2.2 → api_24sea-0.2.4}/pyproject.toml

@@ -13,7 +13,7 @@ classifiers=["Development Status :: 4 - Beta",
              "Environment :: Console",
              "Intended Audience :: Science/Research",
              "Intended Audience :: Information Technology",
-             "License :: OSI Approved :: GNU Affero General Public License v3",
+             "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
              "Natural Language :: English",
              "Operating System :: POSIX :: Linux",
              "Programming Language :: Python :: 3",
@@ -27,7 +27,7 @@ authors = [{ name = "Pietro D'Antuono", email = "pietro.dantuono@24sea.eu" }]
 maintainers = [{ name = "Pietro D'Antuono", email = "pietro.dantuono@24sea.eu" }]
 # -- Project dependencies.
 requires-python = ">=3.8.0"
-dependencies = ["pandas", "requests>=2.32.3", "pydantic>=2.8.2"]
+dependencies = ["pandas", "requests", "pydantic>=2"]
 
 [project.urls]
 "Documentation" = "https://api24seapydocs.blob.core.windows.net/$web/index.html"