# i-Xero2
This is a standardized and customized connector to Xero.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
This package supports the following version of Python. It probably supports older versions, but they have not been tested.
- Python 3.10 or later
### Installing
Install the latest package using pip.
```bash
$ pip install i-xero2
```
End with an example of getting some data out of the system or using it for a little demo
## Running the tests
Before running the tests, you need to authorize the app with Xero and save the tenant ID in the environment.
1. In Xero, switch to the "Demo Company".
1. Run the app locally.
```bash
$ python app.py
```
1. In the browser, navigate to `http://localhost:5000/`
1. Follow the prompts to allow app to access Xero.
1. Read tenants.
1. Copy the `tenantId`.
1. Save the tenant id as an environment variable named `XERO_TENANT_ID`.
1. Run the tests.
```bash
$ python -m pytest
```
## Usage
TODO
## Authors
- **Jason Romano** - [Aracnid](https://github.com/aracnid)
See also the list of [contributors](https://github.com/aracnid/i-xero2/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
Raw data
{
"_id": null,
"home_page": "https://github.com/aracnid/i-xero2",
"name": "i-xero2",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "python, xero",
"author": "Jason Romano",
"author_email": "aracnid@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fe/7e/8b883925dbe5b1f1cbac2edee21d6395a3ef2e9f442f24a58f85ec7cf941/i_xero2-2.8.2.tar.gz",
"platform": null,
"description": "# i-Xero2\n\nThis is a standardized and customized connector to Xero.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nThis package supports the following version of Python. It probably supports older versions, but they have not been tested.\n\n- Python 3.10 or later\n\n### Installing\n\nInstall the latest package using pip.\n\n```bash\n$ pip install i-xero2\n```\n\nEnd with an example of getting some data out of the system or using it for a little demo\n\n## Running the tests\n\nBefore running the tests, you need to authorize the app with Xero and save the tenant ID in the environment.\n\n1. In Xero, switch to the \"Demo Company\".\n1. Run the app locally.\n\n ```bash\n $ python app.py\n ```\n\n1. In the browser, navigate to `http://localhost:5000/`\n1. Follow the prompts to allow app to access Xero.\n1. Read tenants.\n1. Copy the `tenantId`.\n1. Save the tenant id as an environment variable named `XERO_TENANT_ID`.\n1. Run the tests.\n\n ```bash\n $ python -m pytest\n ```\n\n## Usage\n\nTODO\n\n## Authors\n\n- **Jason Romano** - [Aracnid](https://github.com/aracnid)\n\nSee also the list of [contributors](https://github.com/aracnid/i-xero2/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Custom connector to Xero",
"version": "2.8.2",
"project_urls": {
"Homepage": "https://github.com/aracnid/i-xero2",
"Repository": "https://github.com/aracnid/i-xero2"
},
"split_keywords": [
"python",
" xero"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2138ab1126df23c1fd9963ed84a5258409280290e2996db2fa4a20ef2acde311",
"md5": "21c9c31899fb552560b75491d654f752",
"sha256": "bfa28810d3b89eccc9fbf7781737b59c06b7d4b2feeb4d850dcf32609279bdce"
},
"downloads": -1,
"filename": "i_xero2-2.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21c9c31899fb552560b75491d654f752",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 11970,
"upload_time": "2024-03-25T22:23:14",
"upload_time_iso_8601": "2024-03-25T22:23:14.585377Z",
"url": "https://files.pythonhosted.org/packages/21/38/ab1126df23c1fd9963ed84a5258409280290e2996db2fa4a20ef2acde311/i_xero2-2.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe7e8b883925dbe5b1f1cbac2edee21d6395a3ef2e9f442f24a58f85ec7cf941",
"md5": "81bb0526305073b9c622174abe3d33f7",
"sha256": "ab2f0a1f764a3d02118d6319105833faf4b3ec85955eb2ea74688151c92972ba"
},
"downloads": -1,
"filename": "i_xero2-2.8.2.tar.gz",
"has_sig": false,
"md5_digest": "81bb0526305073b9c622174abe3d33f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 11496,
"upload_time": "2024-03-25T22:23:16",
"upload_time_iso_8601": "2024-03-25T22:23:16.379333Z",
"url": "https://files.pythonhosted.org/packages/fe/7e/8b883925dbe5b1f1cbac2edee21d6395a3ef2e9f442f24a58f85ec7cf941/i_xero2-2.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 22:23:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aracnid",
"github_project": "i-xero2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "i-xero2"
}
JSON
