pylister


Namepylister JSON
Version 1.0.3 PyPI version JSON
download
home_page
Summary
upload_time2022-12-13 16:48:33
maintainer
docs_urlNone
authorrecleun
requires_python
license
keywords cli tool task-management
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Pylister

Pylister is a tool that you can use to manage your projects through the terminal.\
It is pretty simple to use. You add projects to Pylister (no directories needed, only a name is enough), you can also add descriptions to these projects, and the main objective of Pylister is to store and manage the tasks that you create for these projects.

## Installation

*Note: Python is required for installation*
```
pip install pylister
```

## Usage

Notes:
- You can use either `pylister` or `pyl`
- \<Option> is required, [Option] is optional
- For options that need more than one word, use quotation marks:\
    `--desc This is a description` (Wrong)\
    `--desc "This is a description"` (Right)


To see what commands you can use:
```
pylister
```
If you want help for a specific command:
```
pylister [COMMAND] --help
```
Example:
```
pyl addp --help
```

## 1 - Projects

#### 1.1 Listing Projects

```
pylister list
```

#### 1.2 Viewing Project info

*(Can be used to show tasks and their IDs for a specific project)*
```
pylister show <Project Name>
```

Example:

```
pyl show pylister
```

#### 1.3 Adding Projects

```
pylister addproject <Project Name> [--desc Description]
```

Example:

```
pyl addp pylister --desc "This is a description"
```

#### 1.4 Removing Projects

```
pyproject rmproject <Project Name>
```

Example:

```
pyl rmp pylister
```

#### 1.5 Modifying Projects

```
pylister set <Project Name> <name|description> <new>
```

Examples:

*(For description)*
```
pyl set pylister description "This is a new description"
```

*(For name)*
```
pyl set pylister name "New Name"
```

## 2 - Tasks

#### 2.1 Adding Tasks

```
pylister addtask <Project Name> <Task>
```

Example:

```
pyl addt pylister "Improve the readme"
```

#### 2.2 Removing Tasks

```
pylister rmtask <Project Name> <Task ID>
```

Example:

```
pyl rmt pylister 1
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pylister",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "cli,tool,task-management",
    "author": "recleun",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/da/4b/90e95b8ea17ac6b64e6bcbe63812c0d7072ac23d0037c43cb0751af99fb4/pylister-1.0.3.tar.gz",
    "platform": null,
    "description": "# Pylister\r\n\r\nPylister is a tool that you can use to manage your projects through the terminal.\\\r\nIt is pretty simple to use. You add projects to Pylister (no directories needed, only a name is enough), you can also add descriptions to these projects, and the main objective of Pylister is to store and manage the tasks that you create for these projects.\r\n\r\n## Installation\r\n\r\n*Note: Python is required for installation*\r\n```\r\npip install pylister\r\n```\r\n\r\n## Usage\r\n\r\nNotes:\r\n- You can use either `pylister` or `pyl`\r\n- \\<Option> is required, [Option] is optional\r\n- For options that need more than one word, use quotation marks:\\\r\n    `--desc This is a description` (Wrong)\\\r\n    `--desc \"This is a description\"` (Right)\r\n\r\n\r\nTo see what commands you can use:\r\n```\r\npylister\r\n```\r\nIf you want help for a specific command:\r\n```\r\npylister [COMMAND] --help\r\n```\r\nExample:\r\n```\r\npyl addp --help\r\n```\r\n\r\n## 1 - Projects\r\n\r\n#### 1.1 Listing Projects\r\n\r\n```\r\npylister list\r\n```\r\n\r\n#### 1.2 Viewing Project info\r\n\r\n*(Can be used to show tasks and their IDs for a specific project)*\r\n```\r\npylister show <Project Name>\r\n```\r\n\r\nExample:\r\n\r\n```\r\npyl show pylister\r\n```\r\n\r\n#### 1.3 Adding Projects\r\n\r\n```\r\npylister addproject <Project Name> [--desc Description]\r\n```\r\n\r\nExample:\r\n\r\n```\r\npyl addp pylister --desc \"This is a description\"\r\n```\r\n\r\n#### 1.4 Removing Projects\r\n\r\n```\r\npyproject rmproject <Project Name>\r\n```\r\n\r\nExample:\r\n\r\n```\r\npyl rmp pylister\r\n```\r\n\r\n#### 1.5 Modifying Projects\r\n\r\n```\r\npylister set <Project Name> <name|description> <new>\r\n```\r\n\r\nExamples:\r\n\r\n*(For description)*\r\n```\r\npyl set pylister description \"This is a new description\"\r\n```\r\n\r\n*(For name)*\r\n```\r\npyl set pylister name \"New Name\"\r\n```\r\n\r\n## 2 - Tasks\r\n\r\n#### 2.1 Adding Tasks\r\n\r\n```\r\npylister addtask <Project Name> <Task>\r\n```\r\n\r\nExample:\r\n\r\n```\r\npyl addt pylister \"Improve the readme\"\r\n```\r\n\r\n#### 2.2 Removing Tasks\r\n\r\n```\r\npylister rmtask <Project Name> <Task ID>\r\n```\r\n\r\nExample:\r\n\r\n```\r\npyl rmt pylister 1\r\n```\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "",
    "version": "1.0.3",
    "split_keywords": [
        "cli",
        "tool",
        "task-management"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "395a8d5c4cf3f109324418b1f671e440",
                "sha256": "6275d922d49297c19397ea47097a20e887d4f8e079e0b253a3ee9cecdc30fcf2"
            },
            "downloads": -1,
            "filename": "pylister-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "395a8d5c4cf3f109324418b1f671e440",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5200,
            "upload_time": "2022-12-13T16:48:26",
            "upload_time_iso_8601": "2022-12-13T16:48:26.826538Z",
            "url": "https://files.pythonhosted.org/packages/20/63/49b9c9fb633529c96d2254c8eca0a68df1e9b845cc2182ac8fd332d627b1/pylister-1.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "ddf86311983421983b08e4cbbc3dacbb",
                "sha256": "df081830a5105fe2288778ff512b951861c7b87a8981d196328d9a7fea363fa1"
            },
            "downloads": -1,
            "filename": "pylister-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "ddf86311983421983b08e4cbbc3dacbb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4446,
            "upload_time": "2022-12-13T16:48:33",
            "upload_time_iso_8601": "2022-12-13T16:48:33.329058Z",
            "url": "https://files.pythonhosted.org/packages/da/4b/90e95b8ea17ac6b64e6bcbe63812c0d7072ac23d0037c43cb0751af99fb4/pylister-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-13 16:48:33",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "pylister"
}
        
Elapsed time: 0.05133s