Merge pull request #66 from fa0311/docs/endpoint

docs: how to point the client at another endpoint

Author: fa0311

README.md

@@ -31,6 +31,12 @@ Learn more about the automatically generated Python package here.
 
 [README-generated.md](README-generated.md)
 
+## Related projects
+
+- [twitter-openapi](https://github.com/fa0311/twitter-openapi) the OpenAPI specification both packages are generated from
+- [twitter_api_safe_relay](https://github.com/fa0311/twitter_api_safe_relay) an HTTP relay that runs requests through a logged-in browser; point the client's host at it
+- [twitter-openapi-typescript](https://github.com/fa0311/twitter-openapi-typescript) the same client for TypeScript
+
 ## License
 
 This project is dual licensed. You can choose one of the following licenses:

twitter_openapi_python/README.md

@@ -81,6 +81,19 @@ client.additional_api_headers = {
 };
 ```
 
+### Endpoint
+
+The generated client accepts any host that keeps X's path shape (`/graphql/{queryId}/{operationName}`, `/1.1/...`, `/2/...` under `https://x.com/i/api`). Build the `ApiClient` yourself and hand it to `get_twitter_openapi_python_client`; the login helpers are not involved, so cookies and headers are then up to you (or to whatever answers at that host). For example, [twitter_api_safe_relay](https://github.com/fa0311/twitter_api_safe_relay) answers at `http://localhost:3000/i/api` with a logged-in browser session.
+
+```python
+import twitter_openapi_python_generated as twitter
+from twitter_openapi_python import TwitterOpenapiPython
+
+api_client = twitter.ApiClient(twitter.Configuration(host="http://localhost:3000/i/api"))
+client = TwitterOpenapiPython().get_twitter_openapi_python_client(api_client)
+response = client.get_user_api().get_user_by_screen_name(screen_name="elonmusk")
+```
+
 ## Development
 
 ```shell