{ "info": { "author": "Hans Smit", "author_email": "jcsmit@xs4all.nl", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Build Tools" ], "description": "mrg_gitlab_template\n===================\n\nA Python gitlab template for initiating new projects in gitlab. The\nboilerplate / template files that are copied are based on best-practices\nfor Python package development. The new project contains the following\nfeatures,\n\n* ``tests`` directory for defining unittests\n* ``examples`` directory for placing example snippets\n* ``docs`` \n Sphinx based on the RTD theme for API and\n architectural documentation. It also enables UML\n diagrams to be dynamically generated based on PlantUML\n and graphviz tool.\n* ``run.py`` main script entry point with a generic argument parser implementation.\n* ``versioneer.py`` an automated version numbering system.\n* ``pylint.cfg`` file for source code lexical analysis.\n* ``setup.py``: file for wheel file building and deployment to PyPI server.\n* ``.gitlab-ci.yml`` file for continuous integration for,\n * unit testing\n * code coverage\n * lint analysis\n * Sphinx documentation building\n * Pages documentation generation\n * deployment to PyPI server.\n\n\n\n\nInstallation\n------------\n\nInstall using pip::\n\n pip install mrg_gitlab_template\n\nOr to upgrade::\n\n pip install --upgrade --no-cache-dir mrg_gitlab_template\n\n\nCommand line usage\n------------------\n\nThe ``pygitcopy`` is a command line utility program to create a new project.\nThe help switch provides the command line arguments::\n\n $ pygitcopy --help\n\n usage: pygitcopy [-h] -g GROUP [-p PAGES_DOMAIN] [-u GITLAB_URL] [-a AUTHOR]\n [-e EMAIL] [-y YEAR] [-d DIRECTORY] [-v]\n package\n\n Create new project from template\n\n positional arguments:\n package package name\n\n optional arguments:\n -h, --help show this help message and exit\n -g GROUP, --group GROUP\n the gitlab account. Example: mrg-tools, sci-fv, your\n account name, etc (default: None)\n -p PAGES_DOMAIN, --pages-domain PAGES_DOMAIN\n the gitlab pages url domain. Example: gitlab.io,\n io.esa.int (default: gitlab.io)\n -u GITLAB_URL, --gitlab-url GITLAB_URL\n the gitlab pages url domain. Example: gitlab.com,\n gitlab.esa.int (default: gitlab.com)\n -a AUTHOR, --author AUTHOR\n author name (default: {{author}})\n -e EMAIL, --email EMAIL\n author email (default: {{email}})\n -y YEAR, --year YEAR author email (default: )\n -d DIRECTORY, --directory DIRECTORY\n base directory location (default: .)\n -v, --verbosity Increase output verbosity (default: 0)\n\n\nCreating a new project\n----------------------\n\nExecute the following command::\n\n pygitcopy --group --directory -vv\n\nExecute the following commands to add the new project to gitlab::\n\n cd /\n git init\n git add .\n git commit -m \"First commit\"\n\nNavigate to https://gitlab.com/projects/new\nand create a new project. Your local can be linked to this repository\nusing the following commands::\n\n\n\n git remote add origin https://gitlab.com//.git\n git push -u origin --all\n git push -u origin --tags\n\nTo delete a repository from gitlab, use this link and scroll to the\nend,\n\n* https://gitlab.com///edit\n\n\nCreate \"testproj\" Example\n-------------------------\n\nThis example will show you how to,\n\n* create a virtual environment\n* create a new gitlab repository\n* create a new local project based on this template project\n* link the local project to the repository\n* commit and push the project files to the repository\n\nInstall system requirements::\n\n sudo apt-get install git\n sudo apt-get install virtualenv\n sudo apt-get install plantuml\n\nCreate the new testproj repository project in the gitlab web site:\n\n firefox https://gitlab.com/projects/new\n\nCreate virtual environment::\n\n mkdir ~/venv\n cd ~venv\n virtualenv -p python3 py3\n source py3/bin/activate\n\n\nInstall the template package::\n\n pip install mrg_gitlab_template\n\n\nCreate a new local project and upload to git::\n\n cd ~/PycharmProjects/\n pygitcopy testproj --group mrg-tools\n cd testproj\n git init\n git add .\n git remote add origin https://gitlab.com/mrg-tools/testproj.git\n git push -u origin --all\n\nCheck the gitlab pipelines and generated files,\n\n* https://gitlab.com/mrg-tools/testproj/pipelines\n* https://mrg-tools.gitlab.io/testproj\n* https://mrg-tools.gitlab.io/testproj/doc/\n\nPrepare the project for development::\n\n pip install -r requirements-dev.txt\n export PYTHONPATH=$PWD\n\nRun some tests::\n\n pylint --pylint-rc=pylint.cfg testproj\n pytest\n pytest --cov\n\nBuild the documentation::\n\n cd docs\n make html\n firefox build/html/index.html\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "mrg_gitlab_template", "package_url": "https://pypi.org/project/mrg_gitlab_template/", "platform": "", "project_url": "https://pypi.org/project/mrg_gitlab_template/", "project_urls": null, "release_url": "https://pypi.org/project/mrg_gitlab_template/0.6.3/", "requires_dist": null, "requires_python": "", "summary": "A Python gitlab template for initiating new projects in gitlab", "version": "0.6.3" }, "last_serial": 3445388, "releases": { "0.6.1": [ { "comment_text": "", "digests": { "md5": "8b71bfc8906fc0f0ec97ab6700596014", "sha256": "81d1071dd79ffd3c199ff31a3fa8d33c66be43526fa87fe435ff7af53c9954a8" }, "downloads": -1, "filename": "mrg_gitlab_template-0.6.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8b71bfc8906fc0f0ec97ab6700596014", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 73945, "upload_time": "2017-12-22T10:51:09", "url": "https://files.pythonhosted.org/packages/24/6e/cfcdef7051779bbfe580a6a00782132df10683f84ccf23326340f652e20f/mrg_gitlab_template-0.6.1-py2.py3-none-any.whl" } ], "0.6.2": [ { "comment_text": "", "digests": { "md5": "5f337698dc00e6443f32e58cb22159a7", "sha256": "d8f420a9b7dc93f6e47ec8f70b31348790fba49b0a998e73269d48d16762379c" }, "downloads": -1, "filename": "mrg_gitlab_template-0.6.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5f337698dc00e6443f32e58cb22159a7", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 73954, "upload_time": "2017-12-22T10:55:53", "url": "https://files.pythonhosted.org/packages/3b/0b/23a83ad0d70485ff7c3caa3a85336c1800697c7cb602df4be079b341a319/mrg_gitlab_template-0.6.2-py2.py3-none-any.whl" } ], "0.6.3": [ { "comment_text": "", "digests": { "md5": "6bda81c9cca78c5f7e9a6598220e7ec8", "sha256": "2cd53a4106e65f4953dbc01b48f4e3279ccf485cfe908916dcd5fe12db87a9d1" }, "downloads": -1, "filename": "mrg_gitlab_template-0.6.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6bda81c9cca78c5f7e9a6598220e7ec8", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 77356, "upload_time": "2017-12-27T14:40:22", "url": "https://files.pythonhosted.org/packages/04/a7/1d0c8017940110c9d1951be35ce879fd72002747b5db5a6dd5ada705ec8c/mrg_gitlab_template-0.6.3-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6bda81c9cca78c5f7e9a6598220e7ec8", "sha256": "2cd53a4106e65f4953dbc01b48f4e3279ccf485cfe908916dcd5fe12db87a9d1" }, "downloads": -1, "filename": "mrg_gitlab_template-0.6.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6bda81c9cca78c5f7e9a6598220e7ec8", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 77356, "upload_time": "2017-12-27T14:40:22", "url": "https://files.pythonhosted.org/packages/04/a7/1d0c8017940110c9d1951be35ce879fd72002747b5db5a6dd5ada705ec8c/mrg_gitlab_template-0.6.3-py2.py3-none-any.whl" } ] }