=============
gemfileparser
=============
gemfileparser parses Ruby Gemfile using Python with supports Ruby Gemfiles
and .gemspec files as well as Cocoapod .podspec files.
Installation
~~~~~~~~~~~~
In a virtualenv, use the command::
pip install gemfileparser
Otherwise from a git clone, use the following commands in a virtualenv::
git clone https://github.com/gemfileparser/gemfileparser.git
cd gemfileparser
python setup.py install
Usage
~~~~~
::
from gemfileparser import GemfileParser
parser = GemfileParser(<path to Gemfile>, <name of the application (optional)>)
dependency_dictionary = parser.parse()
The parse() method returns a dict object of the following format::
{
'development': [list of dependency objects inside group 'development'],
'runtime': [list of runtime dependency objects],
.
.
}
Each dependency object contains the following attributes:
- name - Name of the gem
- requirement - Version requirement
- autorequire - Autorequire value
- source - Source URL of the gem
- parent - Dependency of which gem
- group - Group that a gem is a member of (default : runtime)
Example
~~~~~~~
::
from gemfileparser import GemfileParser
n = GemfileParser('Gemfile', 'diaspora')
deps = n.parse()
for key in deps:
if deps[key]:
print key
for dependency in deps[key]:
print("\t", dependency)
Tests
~~~~~
Do this to run tests::
pip install -e .
pip install pytest
pytest -vvs tests
Copyright
~~~~~~~~~
* Copyright (c) 2020 Gemfileparser authors (listed in AUTHORS file)
* Copyright (c) 2015-2018 Balasankar C <balasankarc@autistici.org>
License
~~~~~~~
gemfileparser is dual-licensed under your choice of the
`GNU GPL version 3 (or later) License <http://www.gnu.org/licenses/gpl>`_
or the `MIT License <https://opensource.org/licenses/MIT>`_.
It is preferred anyone using this project to respect the GPL-3+ license and use
that itself for derivative works - thus making them also Free Software. But,
your call.
When making contributions to gemfileparser you agree to license these contributions
under the same choice of licenses.
Raw data
{
"_id": null,
"home_page": "https://github.com/gemfileparser/gemfileparser",
"name": "gemfileparser",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Ruby Rubygem Gemfile gemspec Cocoapod podspec",
"author": "Balasankar C",
"author_email": "balasankarc@autistici.org",
"download_url": "https://files.pythonhosted.org/packages/08/5f/7277029065a98d7eef536e138a49edb4f551038e4d0ebc312bcf06ea086d/gemfileparser-0.8.0.tar.gz",
"platform": "",
"description": "=============\ngemfileparser\n=============\n\ngemfileparser parses Ruby Gemfile using Python with supports Ruby Gemfiles\nand .gemspec files as well as Cocoapod .podspec files.\n\n\nInstallation\n~~~~~~~~~~~~\n\nIn a virtualenv, use the command::\n\n pip install gemfileparser\n\nOtherwise from a git clone, use the following commands in a virtualenv::\n\n git clone https://github.com/gemfileparser/gemfileparser.git\n cd gemfileparser\n\tpython setup.py install\n\n\nUsage\n~~~~~\n\n::\n\n from gemfileparser import GemfileParser\n parser = GemfileParser(<path to Gemfile>, <name of the application (optional)>)\n dependency_dictionary = parser.parse()\n\nThe parse() method returns a dict object of the following format::\n\n {\n 'development': [list of dependency objects inside group 'development'],\n 'runtime': [list of runtime dependency objects],\n .\n .\n }\n\nEach dependency object contains the following attributes:\n\n- name - Name of the gem\n- requirement - Version requirement\n- autorequire - Autorequire value\n- source - Source URL of the gem\n- parent - Dependency of which gem\n- group - Group that a gem is a member of (default : runtime)\n\n\nExample\n~~~~~~~\n\n::\n\n from gemfileparser import GemfileParser\n n = GemfileParser('Gemfile', 'diaspora')\n deps = n.parse()\n for key in deps:\n if deps[key]:\n print key\n for dependency in deps[key]:\n print(\"\\t\", dependency)\n\n\nTests\n~~~~~\n\nDo this to run tests::\n\n pip install -e .\n pip install pytest\n pytest -vvs tests\n\n\nCopyright\n~~~~~~~~~\n* Copyright (c) 2020 Gemfileparser authors (listed in AUTHORS file)\n* Copyright (c) 2015-2018 Balasankar C <balasankarc@autistici.org>\n\n\nLicense\n~~~~~~~\n\ngemfileparser is dual-licensed under your choice of the\n`GNU GPL version 3 (or later) License <http://www.gnu.org/licenses/gpl>`_\nor the `MIT License <https://opensource.org/licenses/MIT>`_.\n\nIt is preferred anyone using this project to respect the GPL-3+ license and use\nthat itself for derivative works - thus making them also Free Software. But,\nyour call.\n\nWhen making contributions to gemfileparser you agree to license these contributions\nunder the same choice of licenses.\n\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later OR MIT",
"summary": "Parse Ruby Gemfile, .gemspec and Cocoapod .podspec files using Python.",
"version": "0.8.0",
"split_keywords": [
"ruby",
"rubygem",
"gemfile",
"gemspec",
"cocoapod",
"podspec"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "454742bbde04b8b2ccef9da84fbb43d1",
"sha256": "aed669b729c1f850308d1c373fe425d0c1ce768fa5bdac593e05715c64e2bffc"
},
"downloads": -1,
"filename": "gemfileparser-0.8.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "454742bbde04b8b2ccef9da84fbb43d1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 19160,
"upload_time": "2020-08-26T07:34:15",
"upload_time_iso_8601": "2020-08-26T07:34:15.334720Z",
"url": "https://files.pythonhosted.org/packages/ed/b5/c3f4d21e121a65172f43b08b2699e469e3853455b5def48097f40164bb44/gemfileparser-0.8.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "670b8e9dbbfa7a27f06b5de5a84b855b",
"sha256": "839592e49ea3fd985cec003ef58f8e77009a69ed7644a0c0acc94cf6dd9b8d6e"
},
"downloads": -1,
"filename": "gemfileparser-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "670b8e9dbbfa7a27f06b5de5a84b855b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25531,
"upload_time": "2020-08-26T07:34:17",
"upload_time_iso_8601": "2020-08-26T07:34:17.078784Z",
"url": "https://files.pythonhosted.org/packages/08/5f/7277029065a98d7eef536e138a49edb4f551038e4d0ebc312bcf06ea086d/gemfileparser-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-08-26 07:34:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "gemfileparser",
"github_project": "gemfileparser",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gemfileparser"
}
JSON
