Skip to content

Commit

Permalink
Update README.md and disable some ruff rules (#143)
Browse files Browse the repository at this point in the history
  • Loading branch information
jpbede authored Mar 6, 2024
1 parent 935bca9 commit 682f12c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ pip install aioelectricitymaps
```python
import asyncio

from aioelectricitymaps import ElectricityMaps
from aioelectricitymaps import ElectricityMaps, ZoneRequest


async def main() -> None:
"""Run the example."""
async with ElectricityMaps(token="abc123") as em:
response = await em.latest_carbon_intensity_by_country_code("DE")
response = await em.latest_carbon_intensity(ZoneRequest("DE"))

print(f"Carbon intensity in Germany: {response.data.carbon_intensity} gCO2eq/kWh")
print(f"Carbon intensity in Germany: {response.carbon_intensity} gCO2eq/kWh")


if __name__ == "__main__":
Expand All @@ -48,12 +48,12 @@ functionality. The format of the log is based on
[Keep a Changelog][keepchangelog].

Releases are based on [Semantic Versioning][semver], and use the format
of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
based on the following:

- ``MAJOR``: Incompatible or major changes.
- ``MINOR``: Backwards-compatible new features and enhancements.
- ``PATCH``: Backwards-compatible bugfixes and package updates.
- `MAJOR`: Incompatible or major changes.
- `MINOR`: Backwards-compatible new features and enhancements.
- `PATCH`: Backwards-compatible bugfixes and package updates.

## Contributing

Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ ignore = [
"D417", # False positives in some occasions
"PLR2004", # Just annoying, not really useful
"PLR0913", # Too many arguments
"COM812", # avoid conflicts
"COM819", # avoid conflicts
"ISC001", # avoid conflicts
"ISC002", # avoid conflicts
]
select = ["ALL"]

Expand Down

0 comments on commit 682f12c

Please sign in to comment.