Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstrings to the new api #23

Merged
merged 17 commits into from
Oct 10, 2023
Merged

Add docstrings to the new api #23

merged 17 commits into from
Oct 10, 2023

Conversation

matheusfelipeog
Copy link
Owner

Improvements

  • add docstrings to the world, population and geography packages;
  • update worldometer package docstring

@matheusfelipeog matheusfelipeog added the documentation Improvements or additions to documentation label Oct 10, 2023
@matheusfelipeog matheusfelipeog merged commit 6b63d83 into dev Oct 10, 2023
1 check passed
@matheusfelipeog matheusfelipeog deleted the feat/docstrings branch October 10, 2023 04:10
matheusfelipeog added a commit that referenced this pull request Oct 25, 2023
## Added

- **New module structure (#22)**
   - new scraper module;
   - new world module for public api;
   - get home page counters, like in the old api, but now having a special data class;
   - get population and geography data;
   - set new dependencies;
   - new mapped pages;
   - add some tests.
- **Add docstrings to the new api (#23)**
- **Define explicit fields in all counter dataclasses (#26)**

## Changed

- **Reformulation of all docs (#24)**
   - new fully documented API;
   - new package logo and icon.
 - **Use the new API in the old core module. This is a temporary measure until the module is completely removed. (#25)**
    - warn about the deprecation of the old API and indicate the use of the new one.
- **Update all project metadata (#27)**
- **Change package manager and add action to run tests (#29)**
- **Support only Python `>=3.9, <3.12` (#29)**

## Removed

- **Removed support for Python 3.7 and 3.8 (#29)**

## Deprecated

- **`worldometer.core` and `worldometer.api` deprecated (#25)**

## Fixed

- **Fix old API (#25)**
   - fix: import "requests_html" could not be resolved (#12)
   - fix: problem with Importing and Crashing (#13)
   - fix: issue with "sanitize_metrics" method (#18)
   - fix: navigation Timeout Exceeded Error (#20)
   - fix: import error (#21)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant