Merge pull request #4 from gemfileparser/master

Merge latest master

Author: pombredanne

.gitignore

@@ -56,3 +56,5 @@ docs/_build/
 
 # PyBuilder
 target/
+/tmp/
+/.pytest_cache/

AUTHORS

@@ -0,0 +1,9 @@
+# This file lists contributors who made significant contribution to
+# gemfileparser. This file is not intended to list every contributor to the
+# project, though. For that, check the Git revision history.
+#
+# Names are in alphabetical order, for the sanity of mind.
+
+- Balasankar C <balasankarc@autistici.org>
+- Rohit Potter <rohitpotter12@gmail.com>
+- Philippe Ombredanne <pombredanne@nexb.com>

LICENSE

@@ -0,0 +1,44 @@
+gemfileparser is dual-licensed under your choice of [GNU GPL version 3 (or above) License]
+(http://www.gnu.org/licenses/gpl)
+or the [MIT License](https://opensource.org/licenses/MIT).
+
+Personally, I prefer anyone using this to respect the GPL license and use that
+itself for derivative works - thus making them also Free Software. But, your
+call.
+
+Copyright (c) 2020 Gemfileparser authors (listed in AUTHORS file)
+              2015-2018 Balasankar C <balasankarc@autistici.org>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+.
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE.GPLv3

@@ -1,3 +1,6 @@
+Copyright (c) 2020 Gemfileparser authors (listed in AUTHORS file)
+              2015-2018 Balasankar C <balasankarc@autistici.org>
+
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 

LICENSE.MIT

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2018 Balasankar C
+Copyright (c) 2020 Gemfileparser authors (listed in AUTHORS file)
+              2015-2018 Balasankar C <balasankarc@autistici.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -0,0 +1,12 @@
+graft gemfileparser
+graft tests
+
+include AUTHORS
+include LICENSE.GPLv3
+include LICENSE.MIT
+include MANIFEST.in
+include README.rst
+include setup.cfg
+include setup.py
+
+global-exclude *.py[co] __pycache__ *.*~

README.md

@@ -0,0 +1,94 @@
+=============
+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.