2.x changes

[paul121]

This PR includes proposed (breaking) changes for a 2.x version of farmOS.py. Likely will not merge these changes here but into a new 2.x or main branch.

An overview:

• Remove support for farmOS v1
• Update to pydantic v2
• Use HTTPX for requests library
• Use HTTPX-Auth for OAuth2
• Expose async functions
• Auto-generate sync code from async code (and async tests!)

Using the HTTPX library gives us a few things:

• Pluggable authentication support #63 via the auth parameter
• Most of Pluggable transport backend #64 via HTTPX async support

This library has been restructured so it could be easier to create your own FarmClient class using a different library/transport instead of HTTPX but still leverage the Resource helper methods provided here.

[paul121]

I still need to update documentation and fix some linting errors caused by async -> sync code generation. Existing code should only need to change how the client is instantiated and authorized, all other resource methods should continue to behave as before.

Before:

from farmOS import farmOS

farm = farmOS(
    hostname=FARMOS_HOSTNAME,
    scope="farm_manager",
    client_id="farm",
    version=2,
)
farm.authorize(USERNAME, PASSWORD)

After:

from httpx_auth import OAuth2ResourceOwnerPasswordCredentials
from farmOS import FarmClient

auth = OAuth2ResourceOwnerPasswordCredentials(
    token_url=f"{FARMOS_HOSTNAME}/oauth/token",
    username=USERNAME,
    password=PASSWORD,
    client_id="farm",
    scope="farm_manager",
)
farm = FarmClient(hostname=FARMOS_HOSTNAME, auth=auth)

[paul121]

@symbioquine this async -> sync code generation is using the unasync approach implemented here: https://github.com/encode/httpcore/blob/master/scripts/unasync.py

Curious what you think. I know we had talked about async maybe "isn't worth it" but this is a pretty easy add and includes both sync and async tests (with automation to make sure async->sync changes are committed). I do think async is overkill for most use-cases but its nice to make it available.

[paul121]

A couple updates:

• We've been using these changes for async support in a custom script for Rothamsted and async is proving very useful! (10x improvement when making 100s of requests) https://gist.github.com/paul121/4ba3ae9005a93e1f50410adc756f9b28
• Updated the github action so that the tests run (still pass w/o any changes to tests!)
• Updated documentation, added documentation for async support
  • PR changes filtered to only markdown files visible here
• Still need to investigate linting errors
• Still curious about Use a modern tooling for dependency management and packaging #62