n2yo-api-wrapper 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

n2yo/__init__.py

@@ -1,5 +1,5 @@
 __title__ = "n2yo-api-wrapper"
-__version__ = "0.0.1"
+__version__ = "0.0.2"
 __author__ = "Giampy"
 __license__ = "MIT"
 

n2yo/exceptions.py

@@ -1,2 +1,8 @@
-class InvalidApiKey(Exception):
+class N2YOInvalidKeyException(Exception):
+    pass
+
+class N2YORateLimitException(Exception):
+    pass
+
+class N2YOAPIException(Exception):
     pass

n2yo/n2yo.py

@@ -2,7 +2,7 @@ import logging, requests
 from dacite import from_dict
 
 from .models.search import TleData, SatellitePositionsData, VisualPassesData, RadioPassesData, SatellitesAboveData
-from .exceptions import InvalidApiKey
+from .exceptions import N2YOInvalidKeyException
 
 
 # Set up logging - datetime format, level, and format
@@ -55,7 +55,7 @@ class n2yo:
         data = response.json()
 
         if data.get("error") == "Invalid API Key!":
-            raise InvalidApiKey("The API key is invalid or missing.")
+            raise N2YOInvalidKeyException("The API key is invalid or missing.")
     
         result = from_dict(data_class=TleData, data=data)
         return result
@@ -101,7 +101,7 @@ class n2yo:
         data = response.json()
         
         if data.get("error") == "Invalid API Key!":
-            raise InvalidApiKey("The API key is invalid or missing.")
+            raise N2YOInvalidKeyException("The API key is invalid or missing.")
         
         result = from_dict(data_class=SatellitePositionsData, data=data)
         return result
@@ -157,7 +157,7 @@ class n2yo:
         data = response.json()
 
         if data.get("error") == "Invalid API Key!":
-            raise InvalidApiKey("The API key is invalid or missing.")
+            raise N2YOInvalidKeyException("The API key is invalid or missing.")
     
         result = from_dict(data_class=VisualPassesData, data=data)
         return result
@@ -209,7 +209,7 @@ class n2yo:
         data = response.json()
 
         if data.get("error") == "Invalid API Key!":
-            raise InvalidApiKey("The API key is invalid or missing.")
+            raise N2YOInvalidKeyException("The API key is invalid or missing.")
         
         result = from_dict(data_class=RadioPassesData, data=data)
         return result
@@ -257,7 +257,7 @@ class n2yo:
         data = response.json()
 
         if data.get("error") == "Invalid API Key!":
-            raise InvalidApiKey("The API key is invalid or missing.")
+            raise N2YOInvalidKeyException("The API key is invalid or missing.")
         
         result = from_dict(data_class=SatellitesAboveData, data=data)
 

n2yo_api_wrapper-0.0.2.dist-info/METADATA

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: n2yo-api-wrapper
+Version: 0.0.2
+Summary: Unofficial Wrapper for N2YO.com API
+Home-page: https://github.com/g1ampy/n2yo-api-wrapper
+Author: Giampy
+Author-email: g1ampy@proton.me
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: requests
+Requires-Dist: dacite
+Requires-Dist: beautifulsoup4
+
+<div align='center'>
+    <img src='readme/icon.png' width='200'/>
+    <h2>🛰️ N2YO.com Python API Wrapper</h2>
+</div>
+
+<p align='center'>
+  <p align='center'>
+    <a href='https://github.com/g1ampy/n2yo-api-wrapper/stargazers'><img alt='Stars' src='https://img.shields.io/github/stars/g1ampy/n2yo-api-wrapper?color=blue'/></a>
+    <a href='https://github.com/g1ampy/n2yo-api-wrapper/forks'><img alt='Forks' src='https://img.shields.io/github/forks/g1ampy/n2yo-api-wrapper?color=blue'/></a>
+    <a href='https://github.com/g1ampy/n2yo-api-wrapper/releases'><img alt='GitHub release' src='https://img.shields.io/github/v/release/g1ampy/n2yo-api-wrapper?color=blue'/></a>
+    <a href='https://github.com/g1ampy/n2yo-api-wrapper/blob/main/LICENSE'><img alt='License' src='https://img.shields.io/github/license/g1ampy/n2yo-api-wrapper?color=blue'/></a>
+    <a href='https://pypi.org/project/n2yo-api.wrapper/'><img alt='PyPI' src='https://img.shields.io/pypi/v/n2yo-api-wrapper?color=blue'></a>
+    </p>
+</p>
+
+
+<p align='center'> A lightweight, feature-complete Python interface for satellite tracking using N2YO.com's API </p>
+
+### 🛰️ About The Project
+
+A Pythonic interface for accessing real-time satellite data from [N2YO.com](https://www.n2yo.com/api/). This wrapper simplifies interactions with the N2YO API by handling authentication, request formatting, error handling, and response parsing - transforming JSON payloads into native Python objects.
+
+
+### ✨ Key Features
+- **Real-time Satellite Tracking**: Get current position and trajectory data
+- **Pass Prediction**: Calculate visible passes for any location
+- **TLE Data Access**: Retrieve latest orbital parameters
+- **Satellite Search**: Find satellites by name/category
+- **Type Annotations**: Full IDE support and type safety
+
+### ⚙️ Installation
+```bash
+pip install n2yo-api-wrapper
+```
+
+### 🔑 API Key Setup
+  1. **Get a free API key from N2YO.com**
+  2. **Setup client**
+```python
+from n2yo import n2yo
+client = n2yo(api_key="YOUR_API_KEY")'
+```
+
+### 🚀 Usage Examples
+
+```python
+from n2yo import n2yo
+
+# Initialize client
+client = n2yo(api_key="YOUR_API_KEY")
+
+# Get satellite positions
+positions = client.get_satellite_positions(25544, 41.702, -76.014, 500, 10)
+
+# Predict visible passes
+passes = client.get_visual_passes(25544, 41.702, -76.014, 500, 3)
+
+# Retrieve TLE data
+tle = client.get_tle(25544)
+
+# Return all objects within a given search radius above observer's location
+above = client.get_above(41.702, -76.014, 0, 70, 18)
+```
+
+### 📜 Error Handling
+- **N2YOInvalidKeyException:** Invalid API key.
+```python
+try:
+    data = client.get_positions(...)
+except N2YOInvalidKeyException:
+    print("Invalid API key configured")
+```
+
+### 📚 Full Method Reference
+[Please refer to the full documentation](https://www.n2yo.com/api/)
+
+### 📃 License
+
+This project is licensed under the [MIT License](./LICENSE.txt).
+
+### 👨‍💻 Our Contributors
+
+<a href='https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors'>
+    <img src='https://contrib.rocks/image?repo=g1ampy/n2yo-api-wrapper'>
+</a>

n2yo_api_wrapper-0.0.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+n2yo/__init__.py,sha256=N8d3NIbYiFzQ6DuhsHzEGvp-uJ4I7N0f0xwTeKgEmws,119
+n2yo/exceptions.py,sha256=Z-H93Mp4KyQO15A68hpDeESBYBiMWM6hFfKBlULrJfM,146
+n2yo/n2yo.py,sha256=HXNk19W9Z2-ZniaMBXcaLiX9yabzKtvp2y13Xo6qRxc,12242
+n2yo/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+n2yo/models/search.py,sha256=2WMBbBlARzw-oqursCh1v0gmVgMvgne59OOzdg2cUlQ,4883
+n2yo_api_wrapper-0.0.2.dist-info/LICENSE.txt,sha256=KrOVT7b9AFqez4zOs87D00B6dTAQCoeA_-4BXsJw5k0,1063
+n2yo_api_wrapper-0.0.2.dist-info/METADATA,sha256=M5y69e3rW_mJxC-4zzDiFicNHNvstG0Q6WpnFV_16DA,3728
+n2yo_api_wrapper-0.0.2.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+n2yo_api_wrapper-0.0.2.dist-info/top_level.txt,sha256=SzJLCYGYdl8bqgadcbj6EAqoadsVsYxc4UX0VEXWFGw,5
+n2yo_api_wrapper-0.0.2.dist-info/RECORD,,

n2yo_api_wrapper-0.0.1.dist-info/METADATA

@@ -1,255 +0,0 @@
-Metadata-Version: 2.1
-Name: n2yo-api-wrapper
-Version: 0.0.1
-Summary: Unofficial Wrapper for N2YO.com API
-Home-page: https://github.com/g1ampy/n2yo-api-wrapper
-Author: Giampy
-Author-email: g1ampy@proton.me
-License: MIT
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: requests
-Requires-Dist: dacite
-Requires-Dist: beautifulsoup4
-
-<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
-<a id="readme-top"></a>
-<!--
-*** Thanks for checking out the Best-README-Template. If you have a suggestion
-*** that would make this better, please fork the repo and create a pull request
-*** or simply open an issue with the tag "enhancement".
-*** Don't forget to give the project a star!
-*** Thanks again! Now go create something AMAZING! :D
--->
-
-
-
-<!-- PROJECT SHIELDS -->
-<!--
-*** I'm using markdown "reference style" links for readability.
-*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
-*** See the bottom of this document for the declaration of the reference variables
-*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
-*** https://www.markdownguide.org/basic-syntax/#reference-style-links
--->
-[![Forks][forks-shield]][forks-url]
-[![Stargazers][stars-shield]][stars-url]
-[![Contributors][contributors-shield]][contributors-url]
-[![Issues][issues-shield]][issues-url]
-[![PyPi][pypi-shield]][pypi-url]
-[![MIT][license-shield]][license-url]
-
-
-<!-- PROJECT LOGO -->
-<br />
-<div align="center">
-  <a href="https://github.com/g1ampy/n2yo-api-wrapper">
-    <img src="images/logo.png" alt="Logo" width="400">
-  </a>
-
-<h3 align="center">N2YO.com API Wrapper</h3>
-
-  <p align="center">
-    A lightweight and easy-to-use Python wrapper for the N2YO.com API
-    <br />
-    <a href="https://github.com/g1ampy/n2yo-api-wrapper"><strong>« Explore the docs »</strong></a>
-    <br />
-    <br />
-    <a href="https://github.com/g1ampy/n2yo-api-wrapper/issues/new?labels=bug&template=bug-report---.yml">Report Bug</a>
-    &middot;
-    <a href="https://github.com/g1ampy/n2yo-api-wrapper/issues/new?labels=enhancement&template=feature-request---.yml">Request Feature</a>
-  </p>
-</div>
-
-
-
-<!-- TABLE OF CONTENTS -->
-<details>
-  <summary>Table of Contents</summary>
-  <ol>
-    <li>
-      <a href="#about-the-project">About The Project</a>
-      <ul>
-        <li><a href="#built-with">Built With</a></li>
-      </ul>
-    </li>
-    <li>
-      <a href="#getting-started">Getting Started</a>
-      <ul>
-        <li><a href="#prerequisites">Prerequisites</a></li>
-        <li><a href="#installation">Installation</a></li>
-      </ul>
-    </li>
-    <li><a href="#usage">Usage</a></li>
-    <li><a href="#contributing">Contributing</a></li>
-    <li><a href="#license">License</a></li>
-    <li><a href="#contact">Contact</a></li>
-  </ol>
-</details>
-
-
-
-<!-- ABOUT THE PROJECT -->
-## ℹ️ About The Project
-
-The N2YO API Wrapper is a Python tool designed to interact with the N2YO satellite tracking API. It simplifies API requests, handles API keys and parses JSON responses into structured Python objects, providing methods to fetch real-time satellite positions, visible passes and orbital data. This makes it easy for developers to quickly and efficiently integrate satellite tracking and space data into their applications.
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-
-
-### Built With
-
-[![Python][Python]][Python-url]
-[![requests][requests]][requests-url]
-[![dacite][dacite]][dacite-url]
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-
-
-<!-- GETTING STARTED -->
-## 🟢 Getting Started
-
-To use the N2YO.com API Wrapper you can clone the repository or use `pip` package (recommended)
-
-### Prerequisites
-
-- Python 3.10 or higher  
-- A free API key from [https://www.n2yo.com](https://www.n2yo.com)
-
-### Installation
-```sh
-pip install n2yo-api-wrapper
-```
-
-<p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
-
-
-
-<!-- USAGE EXAMPLES -->
-## ❓ Usage
-
-Here’s a basic example of how to use the N2YO API wrapper to track a satellite (e.g., the ISS):
-
-```python
-from n2yo import n2yo
-
-# Initialize the API client with your key
-wrapper = n2yo(api_key="YOUR_API_KEY")
-
-# Get real-time position of the ISS (satellite ID: 25544)
-position = wrapper.get_satellite_positions(
-    id=25544,              
-    observer_lat=41.9028,   # Latitude (e.g., Rome)
-    observer_lng=12.4964,   # Longitude
-    observer_alt=100,       # Altitude in meters
-    seconds=1
-)
-
-print(position)
-```
-
-### 📌 Available Methods
-
-- `get_satellite_positions(...)` – Get current position of a satellite
-- `get_tle(satellite_id)` – Retrieve the TLE data
-- `get_visual_passes(...)` – Get upcoming visible passes
-- `get_radio_passes(...)` – Get upcoming radio passes
-- `get_above(...)` – List satellites currently above a location
-
-_For more examples, please refer to the [Documentation](https://www.n2yo.com/api/)_
-
-<p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
-
-
-
-<!-- CONTRIBUTING -->
-## 🌱 Contributing
-
-Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
-
-If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
-Don't forget to give the project a star! Thanks again!
-
-1. Fork the Project
-2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the Branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
-
-<p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
-
-
-
-### Top contributors:
-
-<a href="https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=g1ampy/n2yo-api-wrapper" alt="contrib.rocks image" />
-</a>
-
-
-
-<!-- LICENSE -->
-## 📜 License
-
-Distributed under the MIT. See `LICENSE.txt` for more information.
-
-<p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
-
-
-
-<!-- CONTACT -->
-## 📥 Contact
-
-<a href="mailto:g1ampy@proton.me">
-    <img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white" alt="Gmail">
-</a>
-
-<p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
-
-
-
-<!-- MARKDOWN LINKS & IMAGES -->
-<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
-[contributors-shield]: https://img.shields.io/github/contributors/g1ampy/n2yo-api-wrapper.svg
-[contributors-url]: https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/g1ampy/n2yo-api-wrapper.svg
-[forks-url]: https://github.com/g1ampy/n2yo-api-wrapper/network/members
-[stars-shield]: https://img.shields.io/github/stars/g1ampy/n2yo-api-wrapper.svg
-[stars-url]: https://github.com/g1ampy/n2yo-api-wrapper/stargazers
-[issues-shield]: https://img.shields.io/github/issues/g1ampy/n2yo-api-wrapper.svg
-[issues-url]: https://github.com/g1ampy/n2yo-api-wrapper/issues
-[pypi-shield]: https://img.shields.io/pypi/v/n2yo-api-wrapper
-[pypi-url]: https://pypi.org/project/n2yo-api-wrapper/
-[license-shield]: https://img.shields.io/github/license/g1ampy/n2yo-api-wrapper.svg
-[license-url]: https://github.com/g1ampy/n2yo-api-wrapper/blob/stable/LICENSE.txt
-[product-screenshot]: images/screenshot.png
-[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
-[Next-url]: https://nextjs.org/
-[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
-[React-url]: https://reactjs.org/
-[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
-[Vue-url]: https://vuejs.org/
-[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
-[Angular-url]: https://angular.io/
-[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
-[Svelte-url]: https://svelte.dev/
-[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
-[Laravel-url]: https://laravel.com
-[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
-[Bootstrap-url]: https://getbootstrap.com
-[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
-[JQuery-url]: https://jquery.com 
-[Python]: https://img.shields.io/badge/python-000000?style=for-the-badge&logo=python&logoColor=white
-[Python-url]: https://python.org/
-[dacite]: https://img.shields.io/badge/dacite-20232A?style=for-the-badge&logo=github&logoColor=61DAFB
-[dacite-url]: https://github.com/konradhalas/dacite
-[requests]: https://img.shields.io/badge/requests-35495E?style=for-the-badge&logo=github&logoColor=4FC08D
-[requests-url]: https://github.com/psf/requests

n2yo_api_wrapper-0.0.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-n2yo/__init__.py,sha256=uZp9NRDAZK9M8vmAV-nz1_rD10Iis7jdRweNKM6P1xQ,119
-n2yo/exceptions.py,sha256=W61iNM2utXJ3twxlqlGF8insKISsoKd-J3jvLMzL6uA,40
-n2yo/n2yo.py,sha256=JZjoawa_NGxI9OAxUVXr7NcwwzK9cmsi22NWGa188S4,12182
-n2yo/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-n2yo/models/search.py,sha256=2WMBbBlARzw-oqursCh1v0gmVgMvgne59OOzdg2cUlQ,4883
-n2yo_api_wrapper-0.0.1.dist-info/LICENSE.txt,sha256=KrOVT7b9AFqez4zOs87D00B6dTAQCoeA_-4BXsJw5k0,1063
-n2yo_api_wrapper-0.0.1.dist-info/METADATA,sha256=0k2tUZQkEiuLW4u6biE7_BlIGiA3ekp45NJjU9jzjlQ,9332
-n2yo_api_wrapper-0.0.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-n2yo_api_wrapper-0.0.1.dist-info/top_level.txt,sha256=SzJLCYGYdl8bqgadcbj6EAqoadsVsYxc4UX0VEXWFGw,5
-n2yo_api_wrapper-0.0.1.dist-info/RECORD,,