| Name | territory JSON |
| Version |
1.2.3
JSON |
| download |
| home_page | None |
| Summary | Client for territory.dev |
| upload_time | 2024-09-02 19:31:01 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Uploading sources with the territory.dev CLI client
===================================================
Watch a video walkthrough:
[](https://www.youtube.com/watch?v=2gYkxGcLPoM)
## 1. Clone a git repository and generate `compile_commands.json`
See examples of how `compile_commands.json` can be generated
[here](https://github.com/territory-dev/builds?tab=readme-ov-file#how-do-i-generate-compile_commandsjson).
## 2. Add a new repo in the territory.dev interface
Go to settings,
find the "[Add](https://app.territory.dev/repos/new)" button under
Repositories,
enter repository details and choose the "Uploaded" option,
create the new repository by clicking "Save".
## 3. Install the client
Install with pip within a Python virtualenv:
```
pip install territory
```
## 4. Run the upload
In the directory containing `compile_commands.json` run
```
territory upload --repo-id $YOUR_REPOSITORY_ID
```
The specific command containing the repository ID can be found in repository
settings under "Recent builds".
First time you use the client, we will open the web brower and you will be
asked to authenticate the client in the web app.
Once the upload finishes, indexing will start.
Non-interactive authentication
==============================
In case you need to run the upload in an environment where the browser
authentication flow is not suitable (e.g. a CI build), you can provide
the necessary token manually.
1. In "Settings" go to to
[Upload tokens](https://app.territory.dev/upload-tokens).
2. Create a new token and save its text to a file.
3. Point the CLI to the file by adding the `--upload-token-path`, e.g.:
```
territory upload \
--upload-token-path /path/to/token \
--repo-id $YOUR_REPOSITORY_ID
```
Raw data
{
"_id": null,
"home_page": null,
"name": "territory",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "\"Pawe\u0142 Z. Stiasny\" <pawel@territory.dev>",
"download_url": "https://files.pythonhosted.org/packages/8e/3e/6cac89a664b352b4393e63c112e20833f2a33fcb882a3f04e61cf6d1a1c3/territory-1.2.3.tar.gz",
"platform": null,
"description": "Uploading sources with the territory.dev CLI client\n===================================================\n\nWatch a video walkthrough:\n\n[](https://www.youtube.com/watch?v=2gYkxGcLPoM)\n\n## 1. Clone a git repository and generate `compile_commands.json`\n\nSee examples of how `compile_commands.json` can be generated\n[here](https://github.com/territory-dev/builds?tab=readme-ov-file#how-do-i-generate-compile_commandsjson).\n\n## 2. Add a new repo in the territory.dev interface\n\nGo to settings,\n\n\n\nfind the \"[Add](https://app.territory.dev/repos/new)\" button under\nRepositories,\n\n\n\nenter repository details and choose the \"Uploaded\" option,\n\n\n\ncreate the new repository by clicking \"Save\".\n\n## 3. Install the client\n\nInstall with pip within a Python virtualenv:\n\n```\npip install territory\n```\n\n## 4. Run the upload\n\nIn the directory containing `compile_commands.json` run\n\n```\nterritory upload --repo-id $YOUR_REPOSITORY_ID\n```\n\nThe specific command containing the repository ID can be found in repository\nsettings under \"Recent builds\".\n\nFirst time you use the client, we will open the web brower and you will be\nasked to authenticate the client in the web app.\n\nOnce the upload finishes, indexing will start.\n\n\nNon-interactive authentication\n==============================\n\nIn case you need to run the upload in an environment where the browser\nauthentication flow is not suitable (e.g. a CI build), you can provide\nthe necessary token manually.\n\n1. In \"Settings\" go to to\n [Upload tokens](https://app.territory.dev/upload-tokens).\n2. Create a new token and save its text to a file.\n3. Point the CLI to the file by adding the `--upload-token-path`, e.g.:\n ```\n territory upload \\\n --upload-token-path /path/to/token \\\n --repo-id $YOUR_REPOSITORY_ID\n ```\n",
"bugtrack_url": null,
"license": null,
"summary": "Client for territory.dev",
"version": "1.2.3",
"project_urls": {
"Home": "https://territory.dev",
"Source": "https://github.com/territory-dev/cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bbfb8f6e22f84d7f814e00da9d73f9f50df8a24de0d869303df561adf9d9d5b9",
"md5": "cf7bd49b68c88c1f3b0accd79aa8b7f0",
"sha256": "8c6012876e552883dc5e9dd67ca0720946d49c0bf91c1dc0077dd48efca7cb62"
},
"downloads": -1,
"filename": "territory-1.2.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf7bd49b68c88c1f3b0accd79aa8b7f0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7653,
"upload_time": "2024-09-02T19:31:00",
"upload_time_iso_8601": "2024-09-02T19:31:00.086782Z",
"url": "https://files.pythonhosted.org/packages/bb/fb/8f6e22f84d7f814e00da9d73f9f50df8a24de0d869303df561adf9d9d5b9/territory-1.2.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8e3e6cac89a664b352b4393e63c112e20833f2a33fcb882a3f04e61cf6d1a1c3",
"md5": "78ce5f0f67a45663b44e3d9edac515bf",
"sha256": "3b26bc18ae09163fe5942f919634faf7ad0337a10763c48700f600acdaa5e824"
},
"downloads": -1,
"filename": "territory-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "78ce5f0f67a45663b44e3d9edac515bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 230310,
"upload_time": "2024-09-02T19:31:01",
"upload_time_iso_8601": "2024-09-02T19:31:01.813285Z",
"url": "https://files.pythonhosted.org/packages/8e/3e/6cac89a664b352b4393e63c112e20833f2a33fcb882a3f04e61cf6d1a1c3/territory-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 19:31:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "territory-dev",
"github_project": "cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "territory"
}
