gitlab-todotxt


Namegitlab-todotxt JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://github.com/vonshednob/gitlab-todotxt
SummarySynchronise your GitLab issues to a todo.txt file
upload_time2020-12-10 20:39:15
maintainer
docs_urlNone
authorR
requires_python>=3.0
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # gitlab-todotxt

A tool to synchronize GitLab issues to a todo.txt file.

When started, gitlab-todotxt will read the configuration file, load all
issues, and write them into a todo.txt-type file of your choice.


## Configuration

gitlab-todotxt requires a configuration file. It expects the configuration
file by default in ~/.config/gitlab-todotxt/gitlab-todotxt.conf.

Each GitLab configuration is a separate section in the configuration file. The
title of that section must not contain any spaces.

This is an example configuration:

    [example.org]
    url = https://gitlab.example.org
    token = your-access-token
    projects = project1, project2
    unassigned = no


The minimal required options are:

 - `url`, the URL to the GitLab instance you are using.
 - `token`, your personal API access token.
 - `file`, the file where to write the tasks into.

Additional options are:

 - `namespaces`, the list of namespaces to consider when importing issues.
   Only namespaces on this list will be considered when imporrting issues.
   When left empty (the default), all accessible namespaces are considered.
 - `projects`, the list of projects to consider when importing issues. Only
   projects on this list will be considered when importing issues. When left
   empty (the default), all accessible projects are considered.
 - `users`, the list of users to consider when importing issues. Only issues
   that are assigned to a user of this list (or to yourself) are considered
   for importing. When empty (the default) no issues, unless assigned to you,
   are imported.
 - `unassigned`, whether or not unassigned issues should be imported.
 - `labels-are-projects`, whether or not labels of issues should be added as
   project tags.
 - `milestone-prefix`, the prefix you would like to have before the
   `milestone` element, if there is a milestone. Defaults to `milestone:`.
 - `format`, the format to write the todo.txt task in. See below for details.


### Format Option

The `format` option in the configuration can be used to customize in what
form your todo.txt tasks are written to file.

The default is

    {delegate} {title} {due} {project} {milestone} {estimate} {spent} {url}

These are also all possible fields:

 - `delegate`: if an issue is assigned to someone else than you, `@delegated`
   will be written in this place, followed by `to:` and the username of those
   the issue is assigned to
 - `title`: the title of the issue,
 - `due`: the due date of the issue or, if there is none, the due date of the
   milestone this task belongs to (if any); in form of a `due:` tag.
 - `project`: the project this task belongs to.
 - `spent`: the time spent on the task.
 - `estimate`: the estimated time for the task.
 - `milestone`: the milestone of the issue.
 - `url`: the URL to the actual issue at the GitLab website




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/vonshednob/gitlab-todotxt",
    "name": "gitlab-todotxt",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "R",
    "author_email": "devel+gitlab-todotxt@kakaomilchkuh.de",
    "download_url": "https://files.pythonhosted.org/packages/76/bf/92b186885d74dccb753e5726eb911393d46ca3d011a01bce6d71a2bad3a5/gitlab-todotxt-0.1.1.tar.gz",
    "platform": "",
    "description": "# gitlab-todotxt\n\nA tool to synchronize GitLab issues to a todo.txt file.\n\nWhen started, gitlab-todotxt will read the configuration file, load all\nissues, and write them into a todo.txt-type file of your choice.\n\n\n## Configuration\n\ngitlab-todotxt requires a configuration file. It expects the configuration\nfile by default in ~/.config/gitlab-todotxt/gitlab-todotxt.conf.\n\nEach GitLab configuration is a separate section in the configuration file. The\ntitle of that section must not contain any spaces.\n\nThis is an example configuration:\n\n    [example.org]\n    url = https://gitlab.example.org\n    token = your-access-token\n    projects = project1, project2\n    unassigned = no\n\n\nThe minimal required options are:\n\n - `url`, the URL to the GitLab instance you are using.\n - `token`, your personal API access token.\n - `file`, the file where to write the tasks into.\n\nAdditional options are:\n\n - `namespaces`, the list of namespaces to consider when importing issues.\n   Only namespaces on this list will be considered when imporrting issues.\n   When left empty (the default), all accessible namespaces are considered.\n - `projects`, the list of projects to consider when importing issues. Only\n   projects on this list will be considered when importing issues. When left\n   empty (the default), all accessible projects are considered.\n - `users`, the list of users to consider when importing issues. Only issues\n   that are assigned to a user of this list (or to yourself) are considered\n   for importing. When empty (the default) no issues, unless assigned to you,\n   are imported.\n - `unassigned`, whether or not unassigned issues should be imported.\n - `labels-are-projects`, whether or not labels of issues should be added as\n   project tags.\n - `milestone-prefix`, the prefix you would like to have before the\n   `milestone` element, if there is a milestone. Defaults to `milestone:`.\n - `format`, the format to write the todo.txt task in. See below for details.\n\n\n### Format Option\n\nThe `format` option in the configuration can be used to customize in what\nform your todo.txt tasks are written to file.\n\nThe default is\n\n    {delegate} {title} {due} {project} {milestone} {estimate} {spent} {url}\n\nThese are also all possible fields:\n\n - `delegate`: if an issue is assigned to someone else than you, `@delegated`\n   will be written in this place, followed by `to:` and the username of those\n   the issue is assigned to\n - `title`: the title of the issue,\n - `due`: the due date of the issue or, if there is none, the due date of the\n   milestone this task belongs to (if any); in form of a `due:` tag.\n - `project`: the project this task belongs to.\n - `spent`: the time spent on the task.\n - `estimate`: the estimated time for the task.\n - `milestone`: the milestone of the issue.\n - `url`: the URL to the actual issue at the GitLab website\n\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Synchronise your GitLab issues to a todo.txt file",
    "version": "0.1.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "77dedf86c8148b87454628818a504f32",
                "sha256": "4235c70e2fc115cbf647943459941a4a4989fd4dde11198249bef382eed5f93b"
            },
            "downloads": -1,
            "filename": "gitlab_todotxt-0.1.1-py3-none-any.whl",
            "has_sig": true,
            "md5_digest": "77dedf86c8148b87454628818a504f32",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.0",
            "size": 7737,
            "upload_time": "2020-12-10T20:39:13",
            "upload_time_iso_8601": "2020-12-10T20:39:13.268006Z",
            "url": "https://files.pythonhosted.org/packages/16/36/e0986757e806cbc02213cad68db40c5d22f2ec759e8c8cb92b35b4d8a555/gitlab_todotxt-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f35a8df69d58ee314c0a294535eb27ac",
                "sha256": "bf5f62604a86fb2d00c14c5bd80476f739bef377413748702142ef68515f9983"
            },
            "downloads": -1,
            "filename": "gitlab-todotxt-0.1.1.tar.gz",
            "has_sig": true,
            "md5_digest": "f35a8df69d58ee314c0a294535eb27ac",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 7461,
            "upload_time": "2020-12-10T20:39:15",
            "upload_time_iso_8601": "2020-12-10T20:39:15.503293Z",
            "url": "https://files.pythonhosted.org/packages/76/bf/92b186885d74dccb753e5726eb911393d46ca3d011a01bce6d71a2bad3a5/gitlab-todotxt-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-12-10 20:39:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "vonshednob",
    "error": "Could not fetch GitHub repository",
    "lcname": "gitlab-todotxt"
}
        
R
Elapsed time: 0.14041s