@@ -7,14 +7,9 @@ Let's discover **Task Badger in less than 5 minutes**.
77
88## Setup
99
10- In order to use the API you will need the following details:
11-
12- * Organization slug
13- * You can get this by going to 'My Organization'
14- * Project slug
15- * Go to the 'Projects' page. The slug for each project is listed.
16- * API Key
17- * Create one on your Profile page
10+ To get started you will need a ** Project API Key** . You can find this on
11+ the project settings page in the [ Task Badger dashboard] ( https://taskbadger.net ) .
12+ A default key is created automatically when you create a new organization.
1813
1914
2015## Montior Celery Tasks
@@ -29,9 +24,7 @@ from taskbadger.systems.celery import CelerySystemIntegration
2924app = Celery(' hello' , broker = ' amqp://guest@localhost//' )
3025
3126taskbadger.init(
32- organization_slug = " my-org" ,
33- project_slug = " my-project" ,
34- token = " ***" ,
27+ token = " YOUR_API_KEY" ,
3528 tags = {" environment" : " production" },
3629 systems = [CelerySystemIntegration(record_task_args = True )]
3730)
@@ -55,11 +48,10 @@ $ python3 -m pip install taskbadger
5548
5649$ taskbadger configure
5750
58- Organization slug: my-org
59- Project slug: project-x
60- API Key: XYZ.ABC
51+ API Key: YOUR_API_KEY
52+ Project key detected — organization: my-org, project: project-x
6153
62- Config written to ~ /.config/taskbadger/confi
54+ Config written to ~ /.config/taskbadger/config
6355```
6456
6557### Use the CLI to run and monitor the command
@@ -94,21 +86,20 @@ See more about the [CLI](cli.md).
9486 import taskbadger
9587
9688 taskbadger.init(
97- organization_slug="my-org",
98- project_slug="my-project",
99- token="***",
89+ token="YOUR_API_KEY",
10090 tags={"environment": "production"},
10191 )
10292 ```
10393
10494=== "Shell"
10595
106- Export the configuration parameters:
96+ Export the configuration parameters. The organization and project slugs
97+ can be found on the project settings page alongside your API key.
10798
10899 ```shell
109100 export ORG="my-org"
110101 export PROJECT="my-project"
111- export API_KEY="*** "
102+ export API_KEY="YOUR_API_KEY "
112103 ```
113104
114105### Creating a task
0 commit comments