{ "info": { "author": "Allan Freitas", "author_email": "allanfreitasci@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Topic :: Software Development" ], "description": "

\n\n

\n\n

\n\n\n \"PyPI\n \n\n\n \"\"\n\n\n \"PyPI\n\n\n\n \"PyPI\n \n

\n\n

\n\n\n \"\"\n\n\n\n \"\"\n\n\n\n \"\"\n

\n\n\n\nTask Runner(SSH, *soon will run local tasks too*) made in Python\n\n# WIP\n\nIt's a Work in Progress :)\n\n# For the Community and Beginners Like Me :)\n\nThe branch [basepackage](https://github.com/allanfreitas/uptask/tree/basepackage)\nhas a base TEMPLATE for you create your own package in python with and without command line scripts\n\n# Some words about it :)\n\nIt's a tool to run tasks easily on Linux Servers using SSH,\nor on local mode(It's on my next features list)\n\nLike Fabric or Capistrano, It's for my needs to start,\nbut I hope it will serve to others :)\n\n
\n\n# Quick Start\n\n## Install\n```shell\n$ pip install uptask\n```\nIt's only tested on python 3.6 for now :)\n\n## Basic Usage\nAfter install, you must create a folder where you want to keep your files with commands to execute.\n\nEx.: I use ```$HOME/code/scripts```\n\n**Tip: You can organize in subfolders your files** \n\nAfter install/update run the following command on your scripts folder to check what commands are available on your version of **UpTask**\n\n```shell\n$ uptask\n\nUpTask 0.2.1\n\nAvailable Commands:\n init : Create the .env and tasks.uptask file if doesnt exists\n runfile : Read a Simple Text File With Linux Commands to execute\n tasks : Read tasks file and list the available tasks to execute\n run : Read tasks file and execute the requested task\n\nHow run a command?\n updtask runfile mytxtfile\n\n# INFO: Each command has it's own params ##\n```\n\n\n```shell\n$ cd to_your_desired_path\n$ uptask init\n```\nThe command ```uptask init``` will create two files on the current folder:\n\n**.env**\n\n```shell\n# UpTask Env\n# Any Other Vars in the future will be using the \"UPTASK_\" Prefix\nUPTASK_HOST=127.0.0.1\nUPTASK_USER=\nUPTASK_PASS=\n```\n\n**tasks.uptask**\n\n```shell\n# Uptask Tasks File\n@story(checks)\n currentdir\n checkpython\n@endstory\n\n@task(currentdir)\n pwd\n@endtask\n\n@task(checkpython)\n python3 --version\n@endtask\n\n# You can configure .halt tasks for a task, \n# and will be triggered if the task name returned a error\n@task(checkpython.halt)\n echo 'Task checkpython Fail :/'\n@endtask\n```\n\n**Tip: Anything outsite a @\"tag\" > @end\"tag\" tag will be ignored.**\n\n\nNow let's imagine that you have a file with the following contents.\n\n*Filename:* ```check_home_list.txt ```\n\n```shell\n# Any Line starting with a \"#\" will be ignored\n#sudo yum update -y\n\n# You can use many \"one-line\" bash format like the line below\npwd && ls -lah\n\n#this line will trigger a error since \"instal\" it's not a valid \"yum\" command\nsudo yum instal nano\n# but for now the line above will not stop the execution, it's on my next features checklist.\nsudo lid -g wheel\n```\n\n```shell\n$ uptask runfile check_home_list.txt\n```\nIt will output all commands output like if you are running them on the server.\n\n\n## #Version 0.2.1\n\nFor now you have 4 commands only\n\n\n- **init** command > creates the .env with default vars and creates the tasks.uptask file with a example list of tasks\n\n```shell\n$ uptask init\n```\n\n- **runfile** command > needs a file name relative to the path it's been called\n\n```shell \n$ uptask runfile your_file_to_run.txt\n```\n\n- **tasks** command > will read the tasks.uptask file and list the Available \n\n```shell\n$ uptask tasks\n\n#Output\nUpTask 0.2.1\n\nAvailable stories:\n checks\nAvailable tasks:\n currentdir\n checkpython\n checkpython.halt\n```\n\nThe **.halt** tasks are called upon the command before the **.** returns **ExitCode > 0** (Fails/Halts)\n\n- **run** command > will read the tasks.uptask file for a **story** or a **task** matching the name passed \n\n```shell\n#checkpython is a task(contains one or multiline bash commands)\n\t\n$ uptask run checkpython\n\n#Output\nUpTask 0.2.1\n\nRunning Task: checkpython\nPython 3.6.5\n```\n\n\n```shell\n#checks is a story(contains multiple tasks)\n$ uptask run checks \n\n#Output\nUpTask 0.2.1\n\nRunning Story: checks\nRunning Task: currentdir\n/Users/allan/code/python/mytasks\nRunning Task: checkpython\nPython 3.6.5\n```\n\n## A Example GIF :)\n\n**On the image is 0.2.0, but it's the same of 0.2.1**\n\n![UpTask Example GIF](https://i.imgur.com/EqYjyvJ.gif)\n\n\n## Disclaimer\nI'm not a native English speaker, \nif you find any grammar mistakes in the documentation or in the code, \nmake a pull request, open a issue or please let me know by any contact way :)\n\n\n## Contributing\n\nConsidering contributing to the **Uptask**?\n\n**Thank you!**\n\nYou can contribute doing some of theese:\n- send pull requests\n- report bugs \n- asking for new features :)\n\n## License\n\n**Uptask** project is open-source under the [MIT license](https://opensource.org/licenses/MIT).", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/allanfreitas/uptask", "keywords": "tasks development runner", "license": "", "maintainer": "", "maintainer_email": "", "name": "uptask", "package_url": "https://pypi.org/project/uptask/", "platform": "", "project_url": "https://pypi.org/project/uptask/", "project_urls": { "Homepage": "https://github.com/allanfreitas/uptask" }, "release_url": "https://pypi.org/project/uptask/0.2.1/", "requires_dist": null, "requires_python": "", "summary": "Task Runner(Local and SSH) made in Python.", "version": "0.2.1" }, "last_serial": 3817368, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "2be8e4b1d933dc61cc83c3b581c9e229", "sha256": "baa308fb33ae33de5599830f0749166a63a9391cd60071846bdce605458270a4" }, "downloads": -1, "filename": "uptask-0.1.0-py3.6.egg", "has_sig": false, "md5_digest": "2be8e4b1d933dc61cc83c3b581c9e229", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 13535, "upload_time": "2018-04-28T10:36:54", "url": "https://files.pythonhosted.org/packages/38/d0/81c6d41b9ac96ed7a5e8d0119392abf93e107bc0e9c29b52f210137992d2/uptask-0.1.0-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "f59de1ebedde24c966fc37c3c33b6e32", "sha256": "35f978e6cdb36bc0ffd1fc0a7d663820b51205440c8c2ed680fe80016dfa2207" }, "downloads": -1, "filename": "uptask-0.1.0.tar.gz", "has_sig": false, "md5_digest": "f59de1ebedde24c966fc37c3c33b6e32", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6190, "upload_time": "2018-04-22T15:30:34", "url": "https://files.pythonhosted.org/packages/9e/b5/826cb6a6beccf245bdd6205d6f8da3af25cfc7ee6449a5a614bbdd99ef95/uptask-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "43bdd8b41695050f3191327e88abd0ce", "sha256": "e037aa26522cb1d0fe65ce79e2aa9ea5c22a4c030c871258f088c65b1285eb6b" }, "downloads": -1, "filename": "uptask-0.2.0-py3.6.egg", "has_sig": false, "md5_digest": "43bdd8b41695050f3191327e88abd0ce", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 21155, "upload_time": "2018-04-28T18:02:57", "url": "https://files.pythonhosted.org/packages/dd/b8/65e27457d72fd6cff871b0df7a4fac1548429260179d4556bd550a80c326/uptask-0.2.0-py3.6.egg" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "e6cfa86b4a7239354eb7ca10be9c1ea1", "sha256": "ddeb8d6d8bab0b0615adb2f0d6f2df4dc80d33a0df28dce86c923a805e6faaf5" }, "downloads": -1, "filename": "uptask-0.2.1.tar.gz", "has_sig": false, "md5_digest": "e6cfa86b4a7239354eb7ca10be9c1ea1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11880, "upload_time": "2018-04-28T18:10:22", "url": "https://files.pythonhosted.org/packages/ba/64/9b45e262ed3134a76e7751f7e8d504d353068699a642ad211ffd279ecb5a/uptask-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e6cfa86b4a7239354eb7ca10be9c1ea1", "sha256": "ddeb8d6d8bab0b0615adb2f0d6f2df4dc80d33a0df28dce86c923a805e6faaf5" }, "downloads": -1, "filename": "uptask-0.2.1.tar.gz", "has_sig": false, "md5_digest": "e6cfa86b4a7239354eb7ca10be9c1ea1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11880, "upload_time": "2018-04-28T18:10:22", "url": "https://files.pythonhosted.org/packages/ba/64/9b45e262ed3134a76e7751f7e8d504d353068699a642ad211ffd279ecb5a/uptask-0.2.1.tar.gz" } ] }