Metadata-Version: 2.1
Name: investments-python-module
Version: 0.1.0
Summary: A Python module for investment calculations and analysis
Home-page: https://github.com/ricavicentini/py-module
Author: Ricardo Vicentini
Author-email: ric_vicentini@hotmail.com
Project-URL: Bug Reports, https://github.com/ricavicentini/py-module/issues
Project-URL: Source, https://github.com/ricavicentini/py-module
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy >=1.20.0
Requires-Dist: pandas >=1.3.0
Provides-Extra: dev
Requires-Dist: black >=21.0 ; extra == 'dev'
Requires-Dist: flake8 >=3.9 ; extra == 'dev'
Requires-Dist: isort >=5.0 ; extra == 'dev'
Requires-Dist: pytest-cov >=2.0 ; extra == 'dev'
Requires-Dist: pytest >=6.0 ; extra == 'dev'

# Investments Python Module Project

This project is created for learning purposes only. It serves as a practical exercise to understand Python module development, best practices, and software engineering concepts.

## Purpose

This repository is intended for educational purposes only. It is designed to help developers learn and practice:
- Python module development
- Software engineering best practices
- Version control
- Documentation
- Testing methodologies

## License

MIT License

Copyright (c) 2024

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

## Contributing

While this project is primarily for learning purposes, contributions are welcome! Please feel free to:
- Report bugs
- Suggest improvements
- Submit pull requests
- Share your learning experiences

Remember that this is an educational project, so all contributions should be made with the intention of learning and sharing knowledge.

## Getting Started

[Add installation and usage instructions here]

## Project Structure

```
investments-python-module/
├── src/
│   ├── main.py           # Main application entry point
│   └── investments.py    # Core investment functionality
├── tests/
│   ├── __init__.py      # Test package initialization
│   └── test_investments.py  # Unit tests for investments module
├── .gitignore           # Git ignore rules
└── README.md           # Project documentation
```

## Contact

For any questions or suggestions, please contact:
- Email: ric_vicentini@hotmail.com
