All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog.
- (Describe any new features or enhancements here)
- (Describe any changes here)
- (Describe any bug fixes here)
- Initial changelog file.
- Comprehensive API documentation using Sphinx.
- Detailed docstrings for mathematical formulas and astronomical concepts.
- User guide with examples for common use cases.
- Inline comments for complex calculations.
- Contributing guide for new contributors.
- Code of conduct to ensure a welcoming community.
- Logging configuration for better debugging and error tracking.
- Validation module to ensure correct parameter types and ranges.
- Unit tests for all public methods to ensure reliability.
- Continuous integration setup for automated testing.
- Refactoring of the package structure for better organization.
- Documentation for API endpoints and expected responses.
- Add development dependencies to
setup.py. - Implement rate limiting for API requests.
- Add input sanitization for all user inputs.
- Add template for issue reporting and feature requests.
- Adds support for fetching filters from DeepskyLog
- Updates the contrast reserve calculation to directly use surface brightness if available, rather than calculating it from magnitude and object diameters.
- Add method to get lenses from DeepskyLog.
- Use new instruments table from DeepskyLog.
- Make the package typed.
- Add methods to convert instrument types from string to int and vice versa.
- Fix python tests
- Get instruments and eyepieces from the DeepskyLog website.
- Conversion of magnitudes to SQM value and bortle scale and vice versa.
- Make sure all methods are correctly imported in init.py.
- First version of pydeepskylog. Calculates:
- contrast reserve
- Optimal detection magnification