# AutoRunX-Python
AutoRunX is an open source low code framework. The user only needs to run the script by entering the program flowchart configuration file.
If you are a company or organization, you can extend your code base based on this framework with your own products or use cases.
## Usage
1. Install
```sh
pip install autorunx
```
2. Used in Python
```python
import autorunx as arx
arx.run("config.json")
```
2. Used in Linux Command
```sh
autorunx -c "config.json"
```
or
```sh
arx -c "config.json"
```
## Build Release File
1. Build source distribution packages
Used to distribute a 'Python' module or project, packaging the source code into a 'tar.gz' or 'zip' package
```sh
python setup.py sdist # package, default tar.gz
python setup.py sdist --formats=gztar,zip # package, specifying the compression format
```
2. Build a binary distribution package
Multi-platform packaging
If your project needs to install multiple platforms, both Windows and Linux, according to the above method, a variety of formats we have to execute multiple commands, for convenience, you can step in place, execute the following command, you can generate multiple formats of the system
```sh
python setup.py bdist
```
Build wheel package
```sh
# pip install wheel
python setup.py sdist bdist_wheel
```
## Install By Setup.py
Use setup.py to install the package
```sh
python setup.py install
```
If your project is still in development and needs frequent updates, you can use the following command to install it. This method does not actually install the package, but creates a soft link in the system environment to the actual directory where the package is located. After modifying the package, it can take effect without installing it again, which is easy to debug.
```sh
python setup.py develop
```
## Release To PyPi
1. Register PyPi account and get the api token.
2. Create `~/.pypirc` (or `C:/User/${yourname}/.pypirc`) file and edit:
```ini
[distutils]
index-servers=pypi
[pypi]
username=__token__
password=your_token_input_here
```
3. Upload
Before uploading, you need to biuld first.
```
twine upload dist/* # upload all files under dist folder
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Xuanfq/AutoRunX-Python",
"name": "autorunx",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "autorun,auto,run,automatic",
"author": "Xuanfq",
"author_email": "2624208682@qq.com",
"download_url": "https://files.pythonhosted.org/packages/94/a2/f09f293f0206db282b1500bab84c47aadb040a0ff5a5ce314ed346790e25/autorunx-1.1.4.tar.gz",
"platform": null,
"description": "# AutoRunX-Python\r\nAutoRunX is an open source low code framework. The user only needs to run the script by entering the program flowchart configuration file.\r\n\r\nIf you are a company or organization, you can extend your code base based on this framework with your own products or use cases.\r\n\r\n\r\n## Usage\r\n1. Install\r\n```sh\r\npip install autorunx\r\n```\r\n\r\n2. Used in Python\r\n```python\r\nimport autorunx as arx\r\narx.run(\"config.json\")\r\n```\r\n\r\n2. Used in Linux Command\r\n```sh\r\nautorunx -c \"config.json\"\r\n```\r\nor\r\n```sh\r\narx -c \"config.json\"\r\n```\r\n\r\n\r\n## Build Release File\r\n\r\n1. Build source distribution packages\r\n\r\nUsed to distribute a 'Python' module or project, packaging the source code into a 'tar.gz' or 'zip' package\r\n\r\n```sh\r\npython setup.py sdist # package, default tar.gz\r\npython setup.py sdist --formats=gztar,zip # package, specifying the compression format\r\n```\r\n\r\n2. Build a binary distribution package\r\n\r\nMulti-platform packaging\r\n\r\nIf your project needs to install multiple platforms, both Windows and Linux, according to the above method, a variety of formats we have to execute multiple commands, for convenience, you can step in place, execute the following command, you can generate multiple formats of the system\r\n\r\n```sh\r\npython setup.py bdist\r\n```\r\n\r\nBuild wheel package\r\n\r\n```sh\r\n# pip install wheel\r\npython setup.py sdist bdist_wheel\r\n```\r\n\r\n## Install By Setup.py\r\n\r\nUse setup.py to install the package\r\n\r\n```sh\r\npython setup.py install\r\n```\r\n\r\nIf your project is still in development and needs frequent updates, you can use the following command to install it. This method does not actually install the package, but creates a soft link in the system environment to the actual directory where the package is located. After modifying the package, it can take effect without installing it again, which is easy to debug.\r\n\r\n```sh\r\npython setup.py develop\r\n```\r\n\r\n\r\n## Release To PyPi\r\n\r\n1. Register PyPi account and get the api token.\r\n2. Create `~/.pypirc` (or `C:/User/${yourname}/.pypirc`) file and edit:\r\n```ini\r\n[distutils]\r\nindex-servers=pypi\r\n\r\n[pypi]\r\nusername=__token__\r\npassword=your_token_input_here\r\n```\r\n\r\n3. Upload\r\n\r\nBefore uploading, you need to biuld first.\r\n\r\n```\r\ntwine upload dist/* # upload all files under dist folder\r\n```\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "AutoRunX is an open source low code framework.",
"version": "1.1.4",
"project_urls": {
"Homepage": "https://github.com/Xuanfq/AutoRunX-Python"
},
"split_keywords": [
"autorun",
"auto",
"run",
"automatic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e53c0878cda02ab4bd5b4964005263229041824b37c6e7b6ce559479b11ed912",
"md5": "102e85770751363db8a46f0890cf13a5",
"sha256": "59fed9f48b0de0b177dad49714b8a62d797e2c02c97b2c88c44261c444493ada"
},
"downloads": -1,
"filename": "autorunx-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "102e85770751363db8a46f0890cf13a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 27103,
"upload_time": "2024-01-09T12:58:14",
"upload_time_iso_8601": "2024-01-09T12:58:14.095765Z",
"url": "https://files.pythonhosted.org/packages/e5/3c/0878cda02ab4bd5b4964005263229041824b37c6e7b6ce559479b11ed912/autorunx-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "94a2f09f293f0206db282b1500bab84c47aadb040a0ff5a5ce314ed346790e25",
"md5": "81c35e11d9c5dc1692589a68ddbbc078",
"sha256": "7b849cb802edaab8a8dd4632cd0eca9f034674cac0b6a4f7ab3d45dd5f198619"
},
"downloads": -1,
"filename": "autorunx-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "81c35e11d9c5dc1692589a68ddbbc078",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12458,
"upload_time": "2024-01-09T12:58:15",
"upload_time_iso_8601": "2024-01-09T12:58:15.900478Z",
"url": "https://files.pythonhosted.org/packages/94/a2/f09f293f0206db282b1500bab84c47aadb040a0ff5a5ce314ed346790e25/autorunx-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-09 12:58:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Xuanfq",
"github_project": "AutoRunX-Python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "autorunx"
}
JSON
