update readme and project name

Author: snopoke

README.md

@@ -1,95 +1,62 @@
-# taskbadger-python
-A client library for accessing Task Badger
+# Task Badger Python Client
+This is the official Python SDK for [Task Badger](https://taskbadger.net/)
 
-## Usage
-First, create a client:
+---
 
-```python
-from taskbadger import Client
-
-client = Client(base_url="https://api.example.com")
-```
-
-If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
-
-```python
-from taskbadger import AuthenticatedClient
-
-client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
-```
+## Getting Started
 
-Now call your endpoint and use your models:
-
-```python
-from taskbadger.models import MyDataModel
-from taskbadger.api.my_tag import get_my_data_model
-from taskbadger.types import Response
+### Install
 
-my_data: MyDataModel = get_my_data_model.sync(client=client)
-# or if you need more info (e.g. status_code)
-response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```bash
+pip install --upgrade taskbadger
 ```
 
-Or do the same thing with an async version:
+### Configuration
 
 ```python
-from taskbadger.models import MyDataModel
-from taskbadger.api.my_tag import get_my_data_model
-from taskbadger.types import Response
+import taskbadger
 
-my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
-response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
-```
-
-By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
-
-```python
-client = AuthenticatedClient(
-    base_url="https://internal_api.example.com", 
-    token="SuperSecretToken",
-    verify_ssl="/path/to/certificate_bundle.pem",
+taskbadger.init(
+    organization_slug="my-org",
+    project_slug="my-project",
+    token="***"
 )
 ```
 
-You can also disable certificate validation altogether, but beware that **this is a security risk**.
+### Usage
 
 ```python
-client = AuthenticatedClient(
-    base_url="https://internal_api.example.com", 
-    token="SuperSecretToken", 
-    verify_ssl=False
+from taskbadger import Task, Action, EmailIntegration
+
+# create a new task with custom data and an action definition
+task = Task.create(
+    "task name",
+    data={
+        "custom": "data"
+    },
+    actions=[
+        Action(
+            "*/10%,success,error",
+            integration=EmailIntegration(to="me@example.com")
+        )
+    ]
 )
-```
-
-Things to know:
-1. Every path/method combo becomes a Python module with four functions:
-    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
-    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
-    1. `asyncio`: Like `sync` but async instead of blocking
-    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
-
-1. All path/query params, and bodies become method arguments.
-1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-1. Any endpoint which did not have a tag will be in `taskbadger.api.default`
-
-## Building / publishing this Client
-This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
-1. Update the metadata in pyproject.toml (e.g. authors, version)
-1. If you're using a private repository, configure it with Poetry
-    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
-    1. `poetry config http-basic.<your-repository-name> <username> <password>`
-1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
-
-If you want to install this client into another project without publishing it (e.g. for development) then:
-1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
-1. If that project is not using Poetry:
-    1. Build a wheel with `poetry build -f wheel`
-    1. Install that wheel from the other project `pip install <path-to-wheel>`
-
 
-## Updating the autogenerated code
-```shell
-poetry shell
-cd ../
-openapi-python-client update --path taskbadger-python/taskbadger.yaml --config taskbadger-python/generator_config.yml
+# update the task status to 'processing'
+task.start()
+try:
+   for i in range(100):
+      do_something(i)
+      if i % 10 == 0:
+         # update the progress of the task
+         task.update_progress(i)
+except Exception as e:
+    # record task errors
+    task.error(data={
+        "error": str(e)
+    })
+    raise
+
+# record task success
+task.success()
 ```

pyproject.toml

@@ -1,15 +1,15 @@
 [tool.poetry]
-name = "taskbadger-python"
+name = "taskbadger"
 version = "0.1"
-description = "A client library for accessing Task Badger"
+description = "The official Python SDK for Task Badger"
 
 authors = []
 
 readme = "README.md"
 packages = [
     {include = "taskbadger"},
 ]
-include = ["CHANGELOG.md", "taskbadger/py.typed"]
+include = ["CHANGELOG.md", "taskbadger/internal/py.typed"]
 
 [tool.poetry.dependencies]
 python = "^3.8"