n2yo-api-wrapper 0.0.1__tar.gz → 0.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. n2yo-api-wrapper-0.0.2/PKG-INFO +102 -0
  2. n2yo-api-wrapper-0.0.2/README.md +85 -0
  3. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo/__init__.py +1 -1
  4. n2yo-api-wrapper-0.0.2/n2yo/exceptions.py +8 -0
  5. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo/n2yo.py +6 -6
  6. n2yo-api-wrapper-0.0.2/n2yo_api_wrapper.egg-info/PKG-INFO +102 -0
  7. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/setup.py +1 -1
  8. n2yo-api-wrapper-0.0.1/PKG-INFO +0 -252
  9. n2yo-api-wrapper-0.0.1/README.md +0 -235
  10. n2yo-api-wrapper-0.0.1/n2yo/exceptions.py +0 -2
  11. n2yo-api-wrapper-0.0.1/n2yo_api_wrapper.egg-info/PKG-INFO +0 -252
  12. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/LICENSE.txt +0 -0
  13. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo/models/__init__.py +0 -0
  14. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo/models/search.py +0 -0
  15. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo_api_wrapper.egg-info/SOURCES.txt +0 -0
  16. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo_api_wrapper.egg-info/dependency_links.txt +0 -0
  17. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo_api_wrapper.egg-info/requires.txt +0 -0
  18. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo_api_wrapper.egg-info/top_level.txt +0 -0
  19. {n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/setup.cfg +0 -0
n2yo-api-wrapper-0.0.2/PKG-INFO ADDED
@@ -0,0 +1,102 @@
1
+ Metadata-Version: 2.1
2
+ Name: n2yo-api-wrapper
3
+ Version: 0.0.2
4
+ Summary: Unofficial Wrapper for N2YO.com API
5
+ Home-page: https://github.com/g1ampy/n2yo-api-wrapper
6
+ Author: Giampy
7
+ Author-email: g1ampy@proton.me
8
+ License: MIT
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Programming Language :: Python
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
14
+ Requires-Python: >=3.10
15
+ Description-Content-Type: text/markdown
16
+ License-File: LICENSE.txt
17
+
18
+ <div align='center'>
19
+ <img src='readme/icon.png' width='200'/>
20
+ <h2>🛰️ N2YO.com Python API Wrapper</h2>
21
+ </div>
22
+
23
+ <p align='center'>
24
+ <p align='center'>
25
+ <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>
26
+ <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>
27
+ <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>
28
+ <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>
29
+ <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>
30
+ </p>
31
+ </p>
32
+
33
+
34
+ <p align='center'> A lightweight, feature-complete Python interface for satellite tracking using N2YO.com's API </p>
35
+
36
+ ### 🛰️ About The Project
37
+
38
+ 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.
39
+
40
+
41
+ ### ✨ Key Features
42
+ - **Real-time Satellite Tracking**: Get current position and trajectory data
43
+ - **Pass Prediction**: Calculate visible passes for any location
44
+ - **TLE Data Access**: Retrieve latest orbital parameters
45
+ - **Satellite Search**: Find satellites by name/category
46
+ - **Type Annotations**: Full IDE support and type safety
47
+
48
+ ### ⚙️ Installation
49
+ ```bash
50
+ pip install n2yo-api-wrapper
51
+ ```
52
+
53
+ ### 🔑 API Key Setup
54
+ 1. **Get a free API key from N2YO.com**
55
+ 2. **Setup client**
56
+ ```python
57
+ from n2yo import n2yo
58
+ client = n2yo(api_key="YOUR_API_KEY")'
59
+ ```
60
+
61
+ ### 🚀 Usage Examples
62
+
63
+ ```python
64
+ from n2yo import n2yo
65
+
66
+ # Initialize client
67
+ client = n2yo(api_key="YOUR_API_KEY")
68
+
69
+ # Get satellite positions
70
+ positions = client.get_satellite_positions(25544, 41.702, -76.014, 500, 10)
71
+
72
+ # Predict visible passes
73
+ passes = client.get_visual_passes(25544, 41.702, -76.014, 500, 3)
74
+
75
+ # Retrieve TLE data
76
+ tle = client.get_tle(25544)
77
+
78
+ # Return all objects within a given search radius above observer's location
79
+ above = client.get_above(41.702, -76.014, 0, 70, 18)
80
+ ```
81
+
82
+ ### 📜 Error Handling
83
+ - **N2YOInvalidKeyException:** Invalid API key.
84
+ ```python
85
+ try:
86
+ data = client.get_positions(...)
87
+ except N2YOInvalidKeyException:
88
+ print("Invalid API key configured")
89
+ ```
90
+
91
+ ### 📚 Full Method Reference
92
+ [Please refer to the full documentation](https://www.n2yo.com/api/)
93
+
94
+ ### 📃 License
95
+
96
+ This project is licensed under the [MIT License](./LICENSE.txt).
97
+
98
+ ### 👨‍💻 Our Contributors
99
+
100
+ <a href='https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors'>
101
+ <img src='https://contrib.rocks/image?repo=g1ampy/n2yo-api-wrapper'>
102
+ </a>
n2yo-api-wrapper-0.0.2/README.md ADDED
@@ -0,0 +1,85 @@
1
+ <div align='center'>
2
+ <img src='readme/icon.png' width='200'/>
3
+ <h2>🛰️ N2YO.com Python API Wrapper</h2>
4
+ </div>
5
+
6
+ <p align='center'>
7
+ <p align='center'>
8
+ <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>
9
+ <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>
10
+ <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>
11
+ <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>
12
+ <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>
13
+ </p>
14
+ </p>
15
+
16
+
17
+ <p align='center'> A lightweight, feature-complete Python interface for satellite tracking using N2YO.com's API </p>
18
+
19
+ ### 🛰️ About The Project
20
+
21
+ 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.
22
+
23
+
24
+ ### ✨ Key Features
25
+ - **Real-time Satellite Tracking**: Get current position and trajectory data
26
+ - **Pass Prediction**: Calculate visible passes for any location
27
+ - **TLE Data Access**: Retrieve latest orbital parameters
28
+ - **Satellite Search**: Find satellites by name/category
29
+ - **Type Annotations**: Full IDE support and type safety
30
+
31
+ ### ⚙️ Installation
32
+ ```bash
33
+ pip install n2yo-api-wrapper
34
+ ```
35
+
36
+ ### 🔑 API Key Setup
37
+ 1. **Get a free API key from N2YO.com**
38
+ 2. **Setup client**
39
+ ```python
40
+ from n2yo import n2yo
41
+ client = n2yo(api_key="YOUR_API_KEY")'
42
+ ```
43
+
44
+ ### 🚀 Usage Examples
45
+
46
+ ```python
47
+ from n2yo import n2yo
48
+
49
+ # Initialize client
50
+ client = n2yo(api_key="YOUR_API_KEY")
51
+
52
+ # Get satellite positions
53
+ positions = client.get_satellite_positions(25544, 41.702, -76.014, 500, 10)
54
+
55
+ # Predict visible passes
56
+ passes = client.get_visual_passes(25544, 41.702, -76.014, 500, 3)
57
+
58
+ # Retrieve TLE data
59
+ tle = client.get_tle(25544)
60
+
61
+ # Return all objects within a given search radius above observer's location
62
+ above = client.get_above(41.702, -76.014, 0, 70, 18)
63
+ ```
64
+
65
+ ### 📜 Error Handling
66
+ - **N2YOInvalidKeyException:** Invalid API key.
67
+ ```python
68
+ try:
69
+ data = client.get_positions(...)
70
+ except N2YOInvalidKeyException:
71
+ print("Invalid API key configured")
72
+ ```
73
+
74
+ ### 📚 Full Method Reference
75
+ [Please refer to the full documentation](https://www.n2yo.com/api/)
76
+
77
+ ### 📃 License
78
+
79
+ This project is licensed under the [MIT License](./LICENSE.txt).
80
+
81
+ ### 👨‍💻 Our Contributors
82
+
83
+ <a href='https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors'>
84
+ <img src='https://contrib.rocks/image?repo=g1ampy/n2yo-api-wrapper'>
85
+ </a>
{n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo/__init__.py RENAMED
@@ -1,5 +1,5 @@
1
1
  __title__ = "n2yo-api-wrapper"
2
- __version__ = "0.0.1"
2
+ __version__ = "0.0.2"
3
3
  __author__ = "Giampy"
4
4
  __license__ = "MIT"
5
5
 
n2yo-api-wrapper-0.0.2/n2yo/exceptions.py ADDED
@@ -0,0 +1,8 @@
1
+ class N2YOInvalidKeyException(Exception):
2
+ pass
3
+
4
+ class N2YORateLimitException(Exception):
5
+ pass
6
+
7
+ class N2YOAPIException(Exception):
8
+ pass
{n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/n2yo/n2yo.py RENAMED
@@ -2,7 +2,7 @@ import logging, requests
2
2
  from dacite import from_dict
3
3
 
4
4
  from .models.search import TleData, SatellitePositionsData, VisualPassesData, RadioPassesData, SatellitesAboveData
5
- from .exceptions import InvalidApiKey
5
+ from .exceptions import N2YOInvalidKeyException
6
6
 
7
7
 
8
8
  # Set up logging - datetime format, level, and format
@@ -55,7 +55,7 @@ class n2yo:
55
55
  data = response.json()
56
56
 
57
57
  if data.get("error") == "Invalid API Key!":
58
- raise InvalidApiKey("The API key is invalid or missing.")
58
+ raise N2YOInvalidKeyException("The API key is invalid or missing.")
59
59
 
60
60
  result = from_dict(data_class=TleData, data=data)
61
61
  return result
@@ -101,7 +101,7 @@ class n2yo:
101
101
  data = response.json()
102
102
 
103
103
  if data.get("error") == "Invalid API Key!":
104
- raise InvalidApiKey("The API key is invalid or missing.")
104
+ raise N2YOInvalidKeyException("The API key is invalid or missing.")
105
105
 
106
106
  result = from_dict(data_class=SatellitePositionsData, data=data)
107
107
  return result
@@ -157,7 +157,7 @@ class n2yo:
157
157
  data = response.json()
158
158
 
159
159
  if data.get("error") == "Invalid API Key!":
160
- raise InvalidApiKey("The API key is invalid or missing.")
160
+ raise N2YOInvalidKeyException("The API key is invalid or missing.")
161
161
 
162
162
  result = from_dict(data_class=VisualPassesData, data=data)
163
163
  return result
@@ -209,7 +209,7 @@ class n2yo:
209
209
  data = response.json()
210
210
 
211
211
  if data.get("error") == "Invalid API Key!":
212
- raise InvalidApiKey("The API key is invalid or missing.")
212
+ raise N2YOInvalidKeyException("The API key is invalid or missing.")
213
213
 
214
214
  result = from_dict(data_class=RadioPassesData, data=data)
215
215
  return result
@@ -257,7 +257,7 @@ class n2yo:
257
257
  data = response.json()
258
258
 
259
259
  if data.get("error") == "Invalid API Key!":
260
- raise InvalidApiKey("The API key is invalid or missing.")
260
+ raise N2YOInvalidKeyException("The API key is invalid or missing.")
261
261
 
262
262
  result = from_dict(data_class=SatellitesAboveData, data=data)
263
263
 
n2yo-api-wrapper-0.0.2/n2yo_api_wrapper.egg-info/PKG-INFO ADDED
@@ -0,0 +1,102 @@
1
+ Metadata-Version: 2.1
2
+ Name: n2yo-api-wrapper
3
+ Version: 0.0.2
4
+ Summary: Unofficial Wrapper for N2YO.com API
5
+ Home-page: https://github.com/g1ampy/n2yo-api-wrapper
6
+ Author: Giampy
7
+ Author-email: g1ampy@proton.me
8
+ License: MIT
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Programming Language :: Python
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
14
+ Requires-Python: >=3.10
15
+ Description-Content-Type: text/markdown
16
+ License-File: LICENSE.txt
17
+
18
+ <div align='center'>
19
+ <img src='readme/icon.png' width='200'/>
20
+ <h2>🛰️ N2YO.com Python API Wrapper</h2>
21
+ </div>
22
+
23
+ <p align='center'>
24
+ <p align='center'>
25
+ <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>
26
+ <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>
27
+ <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>
28
+ <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>
29
+ <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>
30
+ </p>
31
+ </p>
32
+
33
+
34
+ <p align='center'> A lightweight, feature-complete Python interface for satellite tracking using N2YO.com's API </p>
35
+
36
+ ### 🛰️ About The Project
37
+
38
+ 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.
39
+
40
+
41
+ ### ✨ Key Features
42
+ - **Real-time Satellite Tracking**: Get current position and trajectory data
43
+ - **Pass Prediction**: Calculate visible passes for any location
44
+ - **TLE Data Access**: Retrieve latest orbital parameters
45
+ - **Satellite Search**: Find satellites by name/category
46
+ - **Type Annotations**: Full IDE support and type safety
47
+
48
+ ### ⚙️ Installation
49
+ ```bash
50
+ pip install n2yo-api-wrapper
51
+ ```
52
+
53
+ ### 🔑 API Key Setup
54
+ 1. **Get a free API key from N2YO.com**
55
+ 2. **Setup client**
56
+ ```python
57
+ from n2yo import n2yo
58
+ client = n2yo(api_key="YOUR_API_KEY")'
59
+ ```
60
+
61
+ ### 🚀 Usage Examples
62
+
63
+ ```python
64
+ from n2yo import n2yo
65
+
66
+ # Initialize client
67
+ client = n2yo(api_key="YOUR_API_KEY")
68
+
69
+ # Get satellite positions
70
+ positions = client.get_satellite_positions(25544, 41.702, -76.014, 500, 10)
71
+
72
+ # Predict visible passes
73
+ passes = client.get_visual_passes(25544, 41.702, -76.014, 500, 3)
74
+
75
+ # Retrieve TLE data
76
+ tle = client.get_tle(25544)
77
+
78
+ # Return all objects within a given search radius above observer's location
79
+ above = client.get_above(41.702, -76.014, 0, 70, 18)
80
+ ```
81
+
82
+ ### 📜 Error Handling
83
+ - **N2YOInvalidKeyException:** Invalid API key.
84
+ ```python
85
+ try:
86
+ data = client.get_positions(...)
87
+ except N2YOInvalidKeyException:
88
+ print("Invalid API key configured")
89
+ ```
90
+
91
+ ### 📚 Full Method Reference
92
+ [Please refer to the full documentation](https://www.n2yo.com/api/)
93
+
94
+ ### 📃 License
95
+
96
+ This project is licensed under the [MIT License](./LICENSE.txt).
97
+
98
+ ### 👨‍💻 Our Contributors
99
+
100
+ <a href='https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors'>
101
+ <img src='https://contrib.rocks/image?repo=g1ampy/n2yo-api-wrapper'>
102
+ </a>
{n2yo-api-wrapper-0.0.1 → n2yo-api-wrapper-0.0.2}/setup.py RENAMED
@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as readme_file:
5
5
 
6
6
  setup(
7
7
  name="n2yo-api-wrapper",
8
- version="0.0.1",
8
+ version="0.0.2",
9
9
  description="Unofficial Wrapper for N2YO.com API",
10
10
  author="Giampy",
11
11
  author_email="g1ampy@proton.me",
n2yo-api-wrapper-0.0.1/PKG-INFO DELETED
@@ -1,252 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: n2yo-api-wrapper
3
- Version: 0.0.1
4
- Summary: Unofficial Wrapper for N2YO.com API
5
- Home-page: https://github.com/g1ampy/n2yo-api-wrapper
6
- Author: Giampy
7
- Author-email: g1ampy@proton.me
8
- License: MIT
9
- Classifier: Development Status :: 4 - Beta
10
- Classifier: Programming Language :: Python
11
- Classifier: Operating System :: OS Independent
12
- Classifier: Intended Audience :: Developers
13
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
14
- Requires-Python: >=3.10
15
- Description-Content-Type: text/markdown
16
- License-File: LICENSE.txt
17
-
18
- <!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
19
- <a id="readme-top"></a>
20
- <!--
21
- *** Thanks for checking out the Best-README-Template. If you have a suggestion
22
- *** that would make this better, please fork the repo and create a pull request
23
- *** or simply open an issue with the tag "enhancement".
24
- *** Don't forget to give the project a star!
25
- *** Thanks again! Now go create something AMAZING! :D
26
- -->
27
-
28
-
29
-
30
- <!-- PROJECT SHIELDS -->
31
- <!--
32
- *** I'm using markdown "reference style" links for readability.
33
- *** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
34
- *** See the bottom of this document for the declaration of the reference variables
35
- *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
36
- *** https://www.markdownguide.org/basic-syntax/#reference-style-links
37
- -->
38
- [![Forks][forks-shield]][forks-url]
39
- [![Stargazers][stars-shield]][stars-url]
40
- [![Contributors][contributors-shield]][contributors-url]
41
- [![Issues][issues-shield]][issues-url]
42
- [![PyPi][pypi-shield]][pypi-url]
43
- [![MIT][license-shield]][license-url]
44
-
45
-
46
- <!-- PROJECT LOGO -->
47
- <br />
48
- <div align="center">
49
- <a href="https://github.com/g1ampy/n2yo-api-wrapper">
50
- <img src="images/logo.png" alt="Logo" width="400">
51
- </a>
52
-
53
- <h3 align="center">N2YO.com API Wrapper</h3>
54
-
55
- <p align="center">
56
- A lightweight and easy-to-use Python wrapper for the N2YO.com API
57
- <br />
58
- <a href="https://github.com/g1ampy/n2yo-api-wrapper"><strong>« Explore the docs »</strong></a>
59
- <br />
60
- <br />
61
- <a href="https://github.com/g1ampy/n2yo-api-wrapper/issues/new?labels=bug&template=bug-report---.yml">Report Bug</a>
62
- &middot;
63
- <a href="https://github.com/g1ampy/n2yo-api-wrapper/issues/new?labels=enhancement&template=feature-request---.yml">Request Feature</a>
64
- </p>
65
- </div>
66
-
67
-
68
-
69
- <!-- TABLE OF CONTENTS -->
70
- <details>
71
- <summary>Table of Contents</summary>
72
- <ol>
73
- <li>
74
- <a href="#about-the-project">About The Project</a>
75
- <ul>
76
- <li><a href="#built-with">Built With</a></li>
77
- </ul>
78
- </li>
79
- <li>
80
- <a href="#getting-started">Getting Started</a>
81
- <ul>
82
- <li><a href="#prerequisites">Prerequisites</a></li>
83
- <li><a href="#installation">Installation</a></li>
84
- </ul>
85
- </li>
86
- <li><a href="#usage">Usage</a></li>
87
- <li><a href="#contributing">Contributing</a></li>
88
- <li><a href="#license">License</a></li>
89
- <li><a href="#contact">Contact</a></li>
90
- </ol>
91
- </details>
92
-
93
-
94
-
95
- <!-- ABOUT THE PROJECT -->
96
- ## ℹ️ About The Project
97
-
98
- 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.
99
-
100
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
101
-
102
-
103
-
104
- ### Built With
105
-
106
- [![Python][Python]][Python-url]
107
- [![requests][requests]][requests-url]
108
- [![dacite][dacite]][dacite-url]
109
-
110
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
111
-
112
-
113
-
114
- <!-- GETTING STARTED -->
115
- ## 🟢 Getting Started
116
-
117
- To use the N2YO.com API Wrapper you can clone the repository or use `pip` package (recommended)
118
-
119
- ### Prerequisites
120
-
121
- - Python 3.10 or higher
122
- - A free API key from [https://www.n2yo.com](https://www.n2yo.com)
123
-
124
- ### Installation
125
- ```sh
126
- pip install n2yo-api-wrapper
127
- ```
128
-
129
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
130
-
131
-
132
-
133
- <!-- USAGE EXAMPLES -->
134
- ## ❓ Usage
135
-
136
- Here’s a basic example of how to use the N2YO API wrapper to track a satellite (e.g., the ISS):
137
-
138
- ```python
139
- from n2yo import n2yo
140
-
141
- # Initialize the API client with your key
142
- wrapper = n2yo(api_key="YOUR_API_KEY")
143
-
144
- # Get real-time position of the ISS (satellite ID: 25544)
145
- position = wrapper.get_satellite_positions(
146
- id=25544,
147
- observer_lat=41.9028, # Latitude (e.g., Rome)
148
- observer_lng=12.4964, # Longitude
149
- observer_alt=100, # Altitude in meters
150
- seconds=1
151
- )
152
-
153
- print(position)
154
- ```
155
-
156
- ### 📌 Available Methods
157
-
158
- - `get_satellite_positions(...)` – Get current position of a satellite
159
- - `get_tle(satellite_id)` – Retrieve the TLE data
160
- - `get_visual_passes(...)` – Get upcoming visible passes
161
- - `get_radio_passes(...)` – Get upcoming radio passes
162
- - `get_above(...)` – List satellites currently above a location
163
-
164
- _For more examples, please refer to the [Documentation](https://www.n2yo.com/api/)_
165
-
166
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
167
-
168
-
169
-
170
- <!-- CONTRIBUTING -->
171
- ## 🌱 Contributing
172
-
173
- Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
174
-
175
- 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".
176
- Don't forget to give the project a star! Thanks again!
177
-
178
- 1. Fork the Project
179
- 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
180
- 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
181
- 4. Push to the Branch (`git push origin feature/AmazingFeature`)
182
- 5. Open a Pull Request
183
-
184
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
185
-
186
-
187
-
188
- ### Top contributors:
189
-
190
- <a href="https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors">
191
- <img src="https://contrib.rocks/image?repo=g1ampy/n2yo-api-wrapper" alt="contrib.rocks image" />
192
- </a>
193
-
194
-
195
-
196
- <!-- LICENSE -->
197
- ## 📜 License
198
-
199
- Distributed under the MIT. See `LICENSE.txt` for more information.
200
-
201
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
202
-
203
-
204
-
205
- <!-- CONTACT -->
206
- ## 📥 Contact
207
-
208
- <a href="mailto:g1ampy@proton.me">
209
- <img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white" alt="Gmail">
210
- </a>
211
-
212
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
213
-
214
-
215
-
216
- <!-- MARKDOWN LINKS & IMAGES -->
217
- <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
218
- [contributors-shield]: https://img.shields.io/github/contributors/g1ampy/n2yo-api-wrapper.svg
219
- [contributors-url]: https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors
220
- [forks-shield]: https://img.shields.io/github/forks/g1ampy/n2yo-api-wrapper.svg
221
- [forks-url]: https://github.com/g1ampy/n2yo-api-wrapper/network/members
222
- [stars-shield]: https://img.shields.io/github/stars/g1ampy/n2yo-api-wrapper.svg
223
- [stars-url]: https://github.com/g1ampy/n2yo-api-wrapper/stargazers
224
- [issues-shield]: https://img.shields.io/github/issues/g1ampy/n2yo-api-wrapper.svg
225
- [issues-url]: https://github.com/g1ampy/n2yo-api-wrapper/issues
226
- [pypi-shield]: https://img.shields.io/pypi/v/n2yo-api-wrapper
227
- [pypi-url]: https://pypi.org/project/n2yo-api-wrapper/
228
- [license-shield]: https://img.shields.io/github/license/g1ampy/n2yo-api-wrapper.svg
229
- [license-url]: https://github.com/g1ampy/n2yo-api-wrapper/blob/stable/LICENSE.txt
230
- [product-screenshot]: images/screenshot.png
231
- [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
232
- [Next-url]: https://nextjs.org/
233
- [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
234
- [React-url]: https://reactjs.org/
235
- [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
236
- [Vue-url]: https://vuejs.org/
237
- [Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
238
- [Angular-url]: https://angular.io/
239
- [Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
240
- [Svelte-url]: https://svelte.dev/
241
- [Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
242
- [Laravel-url]: https://laravel.com
243
- [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
244
- [Bootstrap-url]: https://getbootstrap.com
245
- [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
246
- [JQuery-url]: https://jquery.com
247
- [Python]: https://img.shields.io/badge/python-000000?style=for-the-badge&logo=python&logoColor=white
248
- [Python-url]: https://python.org/
249
- [dacite]: https://img.shields.io/badge/dacite-20232A?style=for-the-badge&logo=github&logoColor=61DAFB
250
- [dacite-url]: https://github.com/konradhalas/dacite
251
- [requests]: https://img.shields.io/badge/requests-35495E?style=for-the-badge&logo=github&logoColor=4FC08D
252
- [requests-url]: https://github.com/psf/requests
n2yo-api-wrapper-0.0.1/README.md DELETED
@@ -1,235 +0,0 @@
1
- <!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
2
- <a id="readme-top"></a>
3
- <!--
4
- *** Thanks for checking out the Best-README-Template. If you have a suggestion
5
- *** that would make this better, please fork the repo and create a pull request
6
- *** or simply open an issue with the tag "enhancement".
7
- *** Don't forget to give the project a star!
8
- *** Thanks again! Now go create something AMAZING! :D
9
- -->
10
-
11
-
12
-
13
- <!-- PROJECT SHIELDS -->
14
- <!--
15
- *** I'm using markdown "reference style" links for readability.
16
- *** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
17
- *** See the bottom of this document for the declaration of the reference variables
18
- *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
19
- *** https://www.markdownguide.org/basic-syntax/#reference-style-links
20
- -->
21
- [![Forks][forks-shield]][forks-url]
22
- [![Stargazers][stars-shield]][stars-url]
23
- [![Contributors][contributors-shield]][contributors-url]
24
- [![Issues][issues-shield]][issues-url]
25
- [![PyPi][pypi-shield]][pypi-url]
26
- [![MIT][license-shield]][license-url]
27
-
28
-
29
- <!-- PROJECT LOGO -->
30
- <br />
31
- <div align="center">
32
- <a href="https://github.com/g1ampy/n2yo-api-wrapper">
33
- <img src="images/logo.png" alt="Logo" width="400">
34
- </a>
35
-
36
- <h3 align="center">N2YO.com API Wrapper</h3>
37
-
38
- <p align="center">
39
- A lightweight and easy-to-use Python wrapper for the N2YO.com API
40
- <br />
41
- <a href="https://github.com/g1ampy/n2yo-api-wrapper"><strong>« Explore the docs »</strong></a>
42
- <br />
43
- <br />
44
- <a href="https://github.com/g1ampy/n2yo-api-wrapper/issues/new?labels=bug&template=bug-report---.yml">Report Bug</a>
45
- &middot;
46
- <a href="https://github.com/g1ampy/n2yo-api-wrapper/issues/new?labels=enhancement&template=feature-request---.yml">Request Feature</a>
47
- </p>
48
- </div>
49
-
50
-
51
-
52
- <!-- TABLE OF CONTENTS -->
53
- <details>
54
- <summary>Table of Contents</summary>
55
- <ol>
56
- <li>
57
- <a href="#about-the-project">About The Project</a>
58
- <ul>
59
- <li><a href="#built-with">Built With</a></li>
60
- </ul>
61
- </li>
62
- <li>
63
- <a href="#getting-started">Getting Started</a>
64
- <ul>
65
- <li><a href="#prerequisites">Prerequisites</a></li>
66
- <li><a href="#installation">Installation</a></li>
67
- </ul>
68
- </li>
69
- <li><a href="#usage">Usage</a></li>
70
- <li><a href="#contributing">Contributing</a></li>
71
- <li><a href="#license">License</a></li>
72
- <li><a href="#contact">Contact</a></li>
73
- </ol>
74
- </details>
75
-
76
-
77
-
78
- <!-- ABOUT THE PROJECT -->
79
- ## ℹ️ About The Project
80
-
81
- 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.
82
-
83
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
84
-
85
-
86
-
87
- ### Built With
88
-
89
- [![Python][Python]][Python-url]
90
- [![requests][requests]][requests-url]
91
- [![dacite][dacite]][dacite-url]
92
-
93
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
94
-
95
-
96
-
97
- <!-- GETTING STARTED -->
98
- ## 🟢 Getting Started
99
-
100
- To use the N2YO.com API Wrapper you can clone the repository or use `pip` package (recommended)
101
-
102
- ### Prerequisites
103
-
104
- - Python 3.10 or higher
105
- - A free API key from [https://www.n2yo.com](https://www.n2yo.com)
106
-
107
- ### Installation
108
- ```sh
109
- pip install n2yo-api-wrapper
110
- ```
111
-
112
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
113
-
114
-
115
-
116
- <!-- USAGE EXAMPLES -->
117
- ## ❓ Usage
118
-
119
- Here’s a basic example of how to use the N2YO API wrapper to track a satellite (e.g., the ISS):
120
-
121
- ```python
122
- from n2yo import n2yo
123
-
124
- # Initialize the API client with your key
125
- wrapper = n2yo(api_key="YOUR_API_KEY")
126
-
127
- # Get real-time position of the ISS (satellite ID: 25544)
128
- position = wrapper.get_satellite_positions(
129
- id=25544,
130
- observer_lat=41.9028, # Latitude (e.g., Rome)
131
- observer_lng=12.4964, # Longitude
132
- observer_alt=100, # Altitude in meters
133
- seconds=1
134
- )
135
-
136
- print(position)
137
- ```
138
-
139
- ### 📌 Available Methods
140
-
141
- - `get_satellite_positions(...)` – Get current position of a satellite
142
- - `get_tle(satellite_id)` – Retrieve the TLE data
143
- - `get_visual_passes(...)` – Get upcoming visible passes
144
- - `get_radio_passes(...)` – Get upcoming radio passes
145
- - `get_above(...)` – List satellites currently above a location
146
-
147
- _For more examples, please refer to the [Documentation](https://www.n2yo.com/api/)_
148
-
149
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
150
-
151
-
152
-
153
- <!-- CONTRIBUTING -->
154
- ## 🌱 Contributing
155
-
156
- Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
157
-
158
- 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".
159
- Don't forget to give the project a star! Thanks again!
160
-
161
- 1. Fork the Project
162
- 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
163
- 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
164
- 4. Push to the Branch (`git push origin feature/AmazingFeature`)
165
- 5. Open a Pull Request
166
-
167
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
168
-
169
-
170
-
171
- ### Top contributors:
172
-
173
- <a href="https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors">
174
- <img src="https://contrib.rocks/image?repo=g1ampy/n2yo-api-wrapper" alt="contrib.rocks image" />
175
- </a>
176
-
177
-
178
-
179
- <!-- LICENSE -->
180
- ## 📜 License
181
-
182
- Distributed under the MIT. See `LICENSE.txt` for more information.
183
-
184
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
185
-
186
-
187
-
188
- <!-- CONTACT -->
189
- ## 📥 Contact
190
-
191
- <a href="mailto:g1ampy@proton.me">
192
- <img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white" alt="Gmail">
193
- </a>
194
-
195
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
196
-
197
-
198
-
199
- <!-- MARKDOWN LINKS & IMAGES -->
200
- <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
201
- [contributors-shield]: https://img.shields.io/github/contributors/g1ampy/n2yo-api-wrapper.svg
202
- [contributors-url]: https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors
203
- [forks-shield]: https://img.shields.io/github/forks/g1ampy/n2yo-api-wrapper.svg
204
- [forks-url]: https://github.com/g1ampy/n2yo-api-wrapper/network/members
205
- [stars-shield]: https://img.shields.io/github/stars/g1ampy/n2yo-api-wrapper.svg
206
- [stars-url]: https://github.com/g1ampy/n2yo-api-wrapper/stargazers
207
- [issues-shield]: https://img.shields.io/github/issues/g1ampy/n2yo-api-wrapper.svg
208
- [issues-url]: https://github.com/g1ampy/n2yo-api-wrapper/issues
209
- [pypi-shield]: https://img.shields.io/pypi/v/n2yo-api-wrapper
210
- [pypi-url]: https://pypi.org/project/n2yo-api-wrapper/
211
- [license-shield]: https://img.shields.io/github/license/g1ampy/n2yo-api-wrapper.svg
212
- [license-url]: https://github.com/g1ampy/n2yo-api-wrapper/blob/stable/LICENSE.txt
213
- [product-screenshot]: images/screenshot.png
214
- [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
215
- [Next-url]: https://nextjs.org/
216
- [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
217
- [React-url]: https://reactjs.org/
218
- [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
219
- [Vue-url]: https://vuejs.org/
220
- [Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
221
- [Angular-url]: https://angular.io/
222
- [Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
223
- [Svelte-url]: https://svelte.dev/
224
- [Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
225
- [Laravel-url]: https://laravel.com
226
- [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
227
- [Bootstrap-url]: https://getbootstrap.com
228
- [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
229
- [JQuery-url]: https://jquery.com
230
- [Python]: https://img.shields.io/badge/python-000000?style=for-the-badge&logo=python&logoColor=white
231
- [Python-url]: https://python.org/
232
- [dacite]: https://img.shields.io/badge/dacite-20232A?style=for-the-badge&logo=github&logoColor=61DAFB
233
- [dacite-url]: https://github.com/konradhalas/dacite
234
- [requests]: https://img.shields.io/badge/requests-35495E?style=for-the-badge&logo=github&logoColor=4FC08D
235
- [requests-url]: https://github.com/psf/requests
n2yo-api-wrapper-0.0.1/n2yo/exceptions.py DELETED
@@ -1,2 +0,0 @@
1
- class InvalidApiKey(Exception):
2
- pass
n2yo-api-wrapper-0.0.1/n2yo_api_wrapper.egg-info/PKG-INFO DELETED
@@ -1,252 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: n2yo-api-wrapper
3
- Version: 0.0.1
4
- Summary: Unofficial Wrapper for N2YO.com API
5
- Home-page: https://github.com/g1ampy/n2yo-api-wrapper
6
- Author: Giampy
7
- Author-email: g1ampy@proton.me
8
- License: MIT
9
- Classifier: Development Status :: 4 - Beta
10
- Classifier: Programming Language :: Python
11
- Classifier: Operating System :: OS Independent
12
- Classifier: Intended Audience :: Developers
13
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
14
- Requires-Python: >=3.10
15
- Description-Content-Type: text/markdown
16
- License-File: LICENSE.txt
17
-
18
- <!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
19
- <a id="readme-top"></a>
20
- <!--
21
- *** Thanks for checking out the Best-README-Template. If you have a suggestion
22
- *** that would make this better, please fork the repo and create a pull request
23
- *** or simply open an issue with the tag "enhancement".
24
- *** Don't forget to give the project a star!
25
- *** Thanks again! Now go create something AMAZING! :D
26
- -->
27
-
28
-
29
-
30
- <!-- PROJECT SHIELDS -->
31
- <!--
32
- *** I'm using markdown "reference style" links for readability.
33
- *** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
34
- *** See the bottom of this document for the declaration of the reference variables
35
- *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
36
- *** https://www.markdownguide.org/basic-syntax/#reference-style-links
37
- -->
38
- [![Forks][forks-shield]][forks-url]
39
- [![Stargazers][stars-shield]][stars-url]
40
- [![Contributors][contributors-shield]][contributors-url]
41
- [![Issues][issues-shield]][issues-url]
42
- [![PyPi][pypi-shield]][pypi-url]
43
- [![MIT][license-shield]][license-url]
44
-
45
-
46
- <!-- PROJECT LOGO -->
47
- <br />
48
- <div align="center">
49
- <a href="https://github.com/g1ampy/n2yo-api-wrapper">
50
- <img src="images/logo.png" alt="Logo" width="400">
51
- </a>
52
-
53
- <h3 align="center">N2YO.com API Wrapper</h3>
54
-
55
- <p align="center">
56
- A lightweight and easy-to-use Python wrapper for the N2YO.com API
57
- <br />
58
- <a href="https://github.com/g1ampy/n2yo-api-wrapper"><strong>« Explore the docs »</strong></a>
59
- <br />
60
- <br />
61
- <a href="https://github.com/g1ampy/n2yo-api-wrapper/issues/new?labels=bug&template=bug-report---.yml">Report Bug</a>
62
- &middot;
63
- <a href="https://github.com/g1ampy/n2yo-api-wrapper/issues/new?labels=enhancement&template=feature-request---.yml">Request Feature</a>
64
- </p>
65
- </div>
66
-
67
-
68
-
69
- <!-- TABLE OF CONTENTS -->
70
- <details>
71
- <summary>Table of Contents</summary>
72
- <ol>
73
- <li>
74
- <a href="#about-the-project">About The Project</a>
75
- <ul>
76
- <li><a href="#built-with">Built With</a></li>
77
- </ul>
78
- </li>
79
- <li>
80
- <a href="#getting-started">Getting Started</a>
81
- <ul>
82
- <li><a href="#prerequisites">Prerequisites</a></li>
83
- <li><a href="#installation">Installation</a></li>
84
- </ul>
85
- </li>
86
- <li><a href="#usage">Usage</a></li>
87
- <li><a href="#contributing">Contributing</a></li>
88
- <li><a href="#license">License</a></li>
89
- <li><a href="#contact">Contact</a></li>
90
- </ol>
91
- </details>
92
-
93
-
94
-
95
- <!-- ABOUT THE PROJECT -->
96
- ## ℹ️ About The Project
97
-
98
- 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.
99
-
100
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
101
-
102
-
103
-
104
- ### Built With
105
-
106
- [![Python][Python]][Python-url]
107
- [![requests][requests]][requests-url]
108
- [![dacite][dacite]][dacite-url]
109
-
110
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
111
-
112
-
113
-
114
- <!-- GETTING STARTED -->
115
- ## 🟢 Getting Started
116
-
117
- To use the N2YO.com API Wrapper you can clone the repository or use `pip` package (recommended)
118
-
119
- ### Prerequisites
120
-
121
- - Python 3.10 or higher
122
- - A free API key from [https://www.n2yo.com](https://www.n2yo.com)
123
-
124
- ### Installation
125
- ```sh
126
- pip install n2yo-api-wrapper
127
- ```
128
-
129
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
130
-
131
-
132
-
133
- <!-- USAGE EXAMPLES -->
134
- ## ❓ Usage
135
-
136
- Here’s a basic example of how to use the N2YO API wrapper to track a satellite (e.g., the ISS):
137
-
138
- ```python
139
- from n2yo import n2yo
140
-
141
- # Initialize the API client with your key
142
- wrapper = n2yo(api_key="YOUR_API_KEY")
143
-
144
- # Get real-time position of the ISS (satellite ID: 25544)
145
- position = wrapper.get_satellite_positions(
146
- id=25544,
147
- observer_lat=41.9028, # Latitude (e.g., Rome)
148
- observer_lng=12.4964, # Longitude
149
- observer_alt=100, # Altitude in meters
150
- seconds=1
151
- )
152
-
153
- print(position)
154
- ```
155
-
156
- ### 📌 Available Methods
157
-
158
- - `get_satellite_positions(...)` – Get current position of a satellite
159
- - `get_tle(satellite_id)` – Retrieve the TLE data
160
- - `get_visual_passes(...)` – Get upcoming visible passes
161
- - `get_radio_passes(...)` – Get upcoming radio passes
162
- - `get_above(...)` – List satellites currently above a location
163
-
164
- _For more examples, please refer to the [Documentation](https://www.n2yo.com/api/)_
165
-
166
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
167
-
168
-
169
-
170
- <!-- CONTRIBUTING -->
171
- ## 🌱 Contributing
172
-
173
- Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
174
-
175
- 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".
176
- Don't forget to give the project a star! Thanks again!
177
-
178
- 1. Fork the Project
179
- 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
180
- 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
181
- 4. Push to the Branch (`git push origin feature/AmazingFeature`)
182
- 5. Open a Pull Request
183
-
184
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
185
-
186
-
187
-
188
- ### Top contributors:
189
-
190
- <a href="https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors">
191
- <img src="https://contrib.rocks/image?repo=g1ampy/n2yo-api-wrapper" alt="contrib.rocks image" />
192
- </a>
193
-
194
-
195
-
196
- <!-- LICENSE -->
197
- ## 📜 License
198
-
199
- Distributed under the MIT. See `LICENSE.txt` for more information.
200
-
201
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
202
-
203
-
204
-
205
- <!-- CONTACT -->
206
- ## 📥 Contact
207
-
208
- <a href="mailto:g1ampy@proton.me">
209
- <img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white" alt="Gmail">
210
- </a>
211
-
212
- <p align="right">(<a href="#readme-top">back to top ⬆️</a>)</p>
213
-
214
-
215
-
216
- <!-- MARKDOWN LINKS & IMAGES -->
217
- <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
218
- [contributors-shield]: https://img.shields.io/github/contributors/g1ampy/n2yo-api-wrapper.svg
219
- [contributors-url]: https://github.com/g1ampy/n2yo-api-wrapper/graphs/contributors
220
- [forks-shield]: https://img.shields.io/github/forks/g1ampy/n2yo-api-wrapper.svg
221
- [forks-url]: https://github.com/g1ampy/n2yo-api-wrapper/network/members
222
- [stars-shield]: https://img.shields.io/github/stars/g1ampy/n2yo-api-wrapper.svg
223
- [stars-url]: https://github.com/g1ampy/n2yo-api-wrapper/stargazers
224
- [issues-shield]: https://img.shields.io/github/issues/g1ampy/n2yo-api-wrapper.svg
225
- [issues-url]: https://github.com/g1ampy/n2yo-api-wrapper/issues
226
- [pypi-shield]: https://img.shields.io/pypi/v/n2yo-api-wrapper
227
- [pypi-url]: https://pypi.org/project/n2yo-api-wrapper/
228
- [license-shield]: https://img.shields.io/github/license/g1ampy/n2yo-api-wrapper.svg
229
- [license-url]: https://github.com/g1ampy/n2yo-api-wrapper/blob/stable/LICENSE.txt
230
- [product-screenshot]: images/screenshot.png
231
- [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
232
- [Next-url]: https://nextjs.org/
233
- [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
234
- [React-url]: https://reactjs.org/
235
- [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
236
- [Vue-url]: https://vuejs.org/
237
- [Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
238
- [Angular-url]: https://angular.io/
239
- [Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
240
- [Svelte-url]: https://svelte.dev/
241
- [Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
242
- [Laravel-url]: https://laravel.com
243
- [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
244
- [Bootstrap-url]: https://getbootstrap.com
245
- [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
246
- [JQuery-url]: https://jquery.com
247
- [Python]: https://img.shields.io/badge/python-000000?style=for-the-badge&logo=python&logoColor=white
248
- [Python-url]: https://python.org/
249
- [dacite]: https://img.shields.io/badge/dacite-20232A?style=for-the-badge&logo=github&logoColor=61DAFB
250
- [dacite-url]: https://github.com/konradhalas/dacite
251
- [requests]: https://img.shields.io/badge/requests-35495E?style=for-the-badge&logo=github&logoColor=4FC08D
252
- [requests-url]: https://github.com/psf/requests