astropenguin / azely Goto Github PK

Update (or fix) the following docs.

• Add description of default values in the azel module and the compute() function
• Add example images of codes in README

Make sure that 'query', 'QUERY', and 'QuErY' are considered to be same.
Note that other parameters are still case-sensitive at this moment:
For example, frame='ICRS' is not allowed.

• Use astropy.coordinates.Longitude and astropy.coordinates.Latitude classes to parse strings of coordinates in the Azely's Location class.
• Use the official ipinfo package for getting current location

• Use minimum Flake8 config (.flake8)
• Update codes to be compatible with the new config

Google Maps APIs cannot be used without an API key since July 2018 and azely outputs an error when it requests the location information from Google Maps.

Add a utility function to parse queries of objects to an iterable. For example, the proposed function lists names of Messier objects in user.toml and all names in solar.toml:

for obj in func(['user:^M[0-9]+$', 'solar:*']):
    print(obj)

user:M1
user:M2
...
solar:Sun
solar:Moon
...

Then update the compute() function like:

for df in azely.compute(['user:^M[0-9]+$', 'solar:*'], 'Tokyo', ...):
    df.el.plot(ylim=(0, 90))

Note that the utility function must only be activated when obj is given as a list or a tuple and the return be a generator; otherwise obj is never parsed even if it is regex-like (i.e., with obj='solar:*', it tries to find an object whose names is * in user.toml).

Fix wrong index name of a DataFrame with the in_utc property.

Add properties (i.e., object's name) to an output DataFrame of compute() using Extending pandas

Add or update functions which are compatible with Python async

• Update version numbers written in:
  • pyproject.toml
  • azely/__init__.py
  • docs/conf.py
  • tests/test_metadata.py
• Remove docs/images/example.png
• Update image URLs in README
  • use .../v0.6.0/docs/_static/*.svg instead of .../master/docs/_static/*.svg

• Use time='today' as a default value of azely.compute() and azely.time.get_time()
• Update docstrings that describe default time value
• Update README

• Add CONTRIBUTING.md to .github
• Move CODE_OF_CONDUCT.md to .github

Implement an option for forcibly updating cache
when query string is given with the special keyword (!).

import azely

# not updated (if cached value already exists)
location = azely.get_location("here")

# forcibly updated
location = azely.get_location("!here")

Use query='aaa!' instead of query='!aaa' to forcibly update information of an object or a location.

• Update the cache_to decorator and get_* functions
• Update related description in docstrings and README

• Add docstring to functions
• Make documentation using sphinx

• Drop support for Python 3.7
• Add support for Python 3.11

• Update workflow scripts
• Update scripts in etc

Add properties (i.e., object's name) to an output DataFrame of compute() using Extending pandas

• Drop Python 3.6 support
• Add Python 3.9-3.10 support