Metadata-Version: 2.4
Name: seds-rocket-alaeddine
Version: 0.1.2
Summary: Rockets, shuttles and circle rockets - SEDS Lab 3
Home-page: https://github.com/mohammedseghiralaa/rocket
Author: Mohammedseghir Alaeddine
Author-email: alaamohammedseghir@gmail.com
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.TXT
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-python
Dynamic: summary

# seds-rocket-alaeddine

A small teaching package (SEDS Lab 3, ESI Sidi Bel Abbès) that simulates
rockets, shuttles and circle-shaped rockets in a 2-D plane.

## Installation

```bash
pip install seds-rocket-alaeddine
```

## Usage

```python
from rocket import Rocket, Shuttle, CircleRocket

a = Rocket(0, 0)
b = Shuttle(3, 4, flights_completed=2)

print(a.get_distance(b))          # 5.0
print(a == Rocket(0, 0))          # True

c = CircleRocket(x=1, y=1, r=2)
print(c.get_area())               # 12.566...
print(c.get_circumference())      # 12.566...
```

## Classes

- `Rocket(x, y)`: a rocket with a position. Methods: `move_rocket()`, `get_distance(other)`, equality with `==`.
- `Shuttle(x, y, flights_completed)`: a reusable `Rocket`.
- `CircleRocket(x, y, r)`: a `Rocket` shaped like a circle of radius `r`, with `get_area()` and `get_circumference()`.

## Author

Mohammedseghir Alaeddine

## License

MIT
