chibi-git 0.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- chibi_git-0.0.1/AUTHORS.rst +13 -0
- chibi_git-0.0.1/CONTRIBUTING.rst +128 -0
- chibi_git-0.0.1/HISTORY.rst +8 -0
- chibi_git-0.0.1/LICENSE +14 -0
- chibi_git-0.0.1/MANIFEST.in +11 -0
- chibi_git-0.0.1/PKG-INFO +62 -0
- chibi_git-0.0.1/README.rst +26 -0
- chibi_git-0.0.1/chibi_git/__init__.py +7 -0
- chibi_git-0.0.1/chibi_git/chibi_git.py +51 -0
- chibi_git-0.0.1/chibi_git/commnad.py +58 -0
- chibi_git-0.0.1/chibi_git/exception.py +2 -0
- chibi_git-0.0.1/chibi_git.egg-info/PKG-INFO +62 -0
- chibi_git-0.0.1/chibi_git.egg-info/SOURCES.txt +27 -0
- chibi_git-0.0.1/chibi_git.egg-info/dependency_links.txt +1 -0
- chibi_git-0.0.1/chibi_git.egg-info/not-zip-safe +1 -0
- chibi_git-0.0.1/chibi_git.egg-info/top_level.txt +1 -0
- chibi_git-0.0.1/docs/Makefile +20 -0
- chibi_git-0.0.1/docs/authors.rst +1 -0
- chibi_git-0.0.1/docs/conf.py +145 -0
- chibi_git-0.0.1/docs/contributing.rst +1 -0
- chibi_git-0.0.1/docs/history.rst +1 -0
- chibi_git-0.0.1/docs/index.rst +20 -0
- chibi_git-0.0.1/docs/installation.rst +51 -0
- chibi_git-0.0.1/docs/make.bat +36 -0
- chibi_git-0.0.1/docs/readme.rst +1 -0
- chibi_git-0.0.1/docs/usage.rst +7 -0
- chibi_git-0.0.1/setup.cfg +29 -0
- chibi_git-0.0.1/setup.py +35 -0
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
.. highlight:: shell
|
|
2
|
+
|
|
3
|
+
============
|
|
4
|
+
Contributing
|
|
5
|
+
============
|
|
6
|
+
|
|
7
|
+
Contributions are welcome, and they are greatly appreciated! Every little bit
|
|
8
|
+
helps, and credit will always be given.
|
|
9
|
+
|
|
10
|
+
You can contribute in many ways:
|
|
11
|
+
|
|
12
|
+
Types of Contributions
|
|
13
|
+
----------------------
|
|
14
|
+
|
|
15
|
+
Report Bugs
|
|
16
|
+
~~~~~~~~~~~
|
|
17
|
+
|
|
18
|
+
Report bugs at https://github.com/dem4ply/chibi_git/issues.
|
|
19
|
+
|
|
20
|
+
If you are reporting a bug, please include:
|
|
21
|
+
|
|
22
|
+
* Your operating system name and version.
|
|
23
|
+
* Any details about your local setup that might be helpful in troubleshooting.
|
|
24
|
+
* Detailed steps to reproduce the bug.
|
|
25
|
+
|
|
26
|
+
Fix Bugs
|
|
27
|
+
~~~~~~~~
|
|
28
|
+
|
|
29
|
+
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
|
|
30
|
+
wanted" is open to whoever wants to implement it.
|
|
31
|
+
|
|
32
|
+
Implement Features
|
|
33
|
+
~~~~~~~~~~~~~~~~~~
|
|
34
|
+
|
|
35
|
+
Look through the GitHub issues for features. Anything tagged with "enhancement"
|
|
36
|
+
and "help wanted" is open to whoever wants to implement it.
|
|
37
|
+
|
|
38
|
+
Write Documentation
|
|
39
|
+
~~~~~~~~~~~~~~~~~~~
|
|
40
|
+
|
|
41
|
+
Chibi_git could always use more documentation, whether as part of the
|
|
42
|
+
official Chibi_git docs, in docstrings, or even on the web in blog posts,
|
|
43
|
+
articles, and such.
|
|
44
|
+
|
|
45
|
+
Submit Feedback
|
|
46
|
+
~~~~~~~~~~~~~~~
|
|
47
|
+
|
|
48
|
+
The best way to send feedback is to file an issue at https://github.com/dem4ply/chibi_git/issues.
|
|
49
|
+
|
|
50
|
+
If you are proposing a feature:
|
|
51
|
+
|
|
52
|
+
* Explain in detail how it would work.
|
|
53
|
+
* Keep the scope as narrow as possible, to make it easier to implement.
|
|
54
|
+
* Remember that this is a volunteer-driven project, and that contributions
|
|
55
|
+
are welcome :)
|
|
56
|
+
|
|
57
|
+
Get Started!
|
|
58
|
+
------------
|
|
59
|
+
|
|
60
|
+
Ready to contribute? Here's how to set up `chibi_git` for local development.
|
|
61
|
+
|
|
62
|
+
1. Fork the `chibi_git` repo on GitHub.
|
|
63
|
+
2. Clone your fork locally::
|
|
64
|
+
|
|
65
|
+
$ git clone git@github.com:your_name_here/chibi_git.git
|
|
66
|
+
|
|
67
|
+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
|
|
68
|
+
|
|
69
|
+
$ mkvirtualenv chibi_git
|
|
70
|
+
$ cd chibi_git/
|
|
71
|
+
$ python setup.py develop
|
|
72
|
+
|
|
73
|
+
4. Create a branch for local development::
|
|
74
|
+
|
|
75
|
+
$ git checkout -b name-of-your-bugfix-or-feature
|
|
76
|
+
|
|
77
|
+
Now you can make your changes locally.
|
|
78
|
+
|
|
79
|
+
5. When you're done making changes, check that your changes pass flake8 and the
|
|
80
|
+
tests, including testing other Python versions with tox::
|
|
81
|
+
|
|
82
|
+
$ flake8 chibi_git tests
|
|
83
|
+
$ python setup.py test or pytest
|
|
84
|
+
$ tox
|
|
85
|
+
|
|
86
|
+
To get flake8 and tox, just pip install them into your virtualenv.
|
|
87
|
+
|
|
88
|
+
6. Commit your changes and push your branch to GitHub::
|
|
89
|
+
|
|
90
|
+
$ git add .
|
|
91
|
+
$ git commit -m "Your detailed description of your changes."
|
|
92
|
+
$ git push origin name-of-your-bugfix-or-feature
|
|
93
|
+
|
|
94
|
+
7. Submit a pull request through the GitHub website.
|
|
95
|
+
|
|
96
|
+
Pull Request Guidelines
|
|
97
|
+
-----------------------
|
|
98
|
+
|
|
99
|
+
Before you submit a pull request, check that it meets these guidelines:
|
|
100
|
+
|
|
101
|
+
1. The pull request should include tests.
|
|
102
|
+
2. If the pull request adds functionality, the docs should be updated. Put
|
|
103
|
+
your new functionality into a function with a docstring, and add the
|
|
104
|
+
feature to the list in README.rst.
|
|
105
|
+
3. The pull request should work for Python 2.7, 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
|
|
106
|
+
https://travis-ci.org/dem4ply/chibi_git/pull_requests
|
|
107
|
+
and make sure that the tests pass for all supported Python versions.
|
|
108
|
+
|
|
109
|
+
Tips
|
|
110
|
+
----
|
|
111
|
+
|
|
112
|
+
To run a subset of tests::
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
$ python -m unittest tests.test_chibi_git
|
|
116
|
+
|
|
117
|
+
Deploying
|
|
118
|
+
---------
|
|
119
|
+
|
|
120
|
+
A reminder for the maintainers on how to deploy.
|
|
121
|
+
Make sure all your changes are committed (including an entry in HISTORY.rst).
|
|
122
|
+
Then run::
|
|
123
|
+
|
|
124
|
+
$ bump2version patch # possible: major / minor / patch
|
|
125
|
+
$ git push
|
|
126
|
+
$ git push --tags
|
|
127
|
+
|
|
128
|
+
Travis will then deploy to PyPI if tests pass.
|
chibi_git-0.0.1/LICENSE
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
|
2
|
+
Version 2, December 2004
|
|
3
|
+
|
|
4
|
+
Copyright (C) 2025 dem4ply <dem4ply@gmail.com>
|
|
5
|
+
|
|
6
|
+
Everyone is permitted to copy and distribute verbatim or modified
|
|
7
|
+
copies of this license document, and changing it is allowed as long
|
|
8
|
+
as the name is changed.
|
|
9
|
+
|
|
10
|
+
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
|
11
|
+
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
|
12
|
+
|
|
13
|
+
0. You just DO WHAT THE FUCK YOU WANT TO.
|
|
14
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
include AUTHORS.rst
|
|
2
|
+
include CONTRIBUTING.rst
|
|
3
|
+
include HISTORY.rst
|
|
4
|
+
include LICENSE
|
|
5
|
+
include README.rst
|
|
6
|
+
|
|
7
|
+
recursive-exclude tests *
|
|
8
|
+
recursive-exclude * __pycache__
|
|
9
|
+
recursive-exclude * *.py[co]
|
|
10
|
+
|
|
11
|
+
recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
|
chibi_git-0.0.1/PKG-INFO
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
|
+
Name: chibi_git
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: wrapper to use git in python
|
|
5
|
+
Home-page: https://github.com/dem4ply/chibi_git
|
|
6
|
+
Author: dem4ply
|
|
7
|
+
Author-email: dem4ply@gmail.com
|
|
8
|
+
License: WTFPL
|
|
9
|
+
Keywords: chibi_git
|
|
10
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: License :: Public Domain
|
|
13
|
+
Classifier: Natural Language :: English
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
16
|
+
License-File: LICENSE
|
|
17
|
+
License-File: AUTHORS.rst
|
|
18
|
+
Dynamic: author
|
|
19
|
+
Dynamic: author-email
|
|
20
|
+
Dynamic: classifier
|
|
21
|
+
Dynamic: description
|
|
22
|
+
Dynamic: home-page
|
|
23
|
+
Dynamic: keywords
|
|
24
|
+
Dynamic: license
|
|
25
|
+
Dynamic: summary
|
|
26
|
+
|
|
27
|
+
=========
|
|
28
|
+
Chibi_git
|
|
29
|
+
=========
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
.. image:: https://img.shields.io/pypi/v/chibi_git.svg
|
|
33
|
+
:target: https://pypi.python.org/pypi/chibi_git
|
|
34
|
+
|
|
35
|
+
.. image:: https://readthedocs.org/projects/chibi-git/badge/?version=latest
|
|
36
|
+
:target: https://chibi-git.readthedocs.io/en/latest/?badge=latest
|
|
37
|
+
:alt: Documentation Status
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
wrapper to use git in python
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
* Free software: WTFPL
|
|
46
|
+
* Documentation: https://chibi-git.readthedocs.io.
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
Features
|
|
50
|
+
--------
|
|
51
|
+
|
|
52
|
+
* TODO
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
=======
|
|
56
|
+
History
|
|
57
|
+
=======
|
|
58
|
+
|
|
59
|
+
0.0.1 (2025-01-22)
|
|
60
|
+
------------------
|
|
61
|
+
|
|
62
|
+
* First release on PyPI.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
=========
|
|
2
|
+
Chibi_git
|
|
3
|
+
=========
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
.. image:: https://img.shields.io/pypi/v/chibi_git.svg
|
|
7
|
+
:target: https://pypi.python.org/pypi/chibi_git
|
|
8
|
+
|
|
9
|
+
.. image:: https://readthedocs.org/projects/chibi-git/badge/?version=latest
|
|
10
|
+
:target: https://chibi-git.readthedocs.io/en/latest/?badge=latest
|
|
11
|
+
:alt: Documentation Status
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
wrapper to use git in python
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
* Free software: WTFPL
|
|
20
|
+
* Documentation: https://chibi-git.readthedocs.io.
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
Features
|
|
24
|
+
--------
|
|
25
|
+
|
|
26
|
+
* TODO
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
from chibi.file import Chibi_path
|
|
3
|
+
from chibi_command import Result_error
|
|
4
|
+
from chibi_git.commnad import Git as Git_command
|
|
5
|
+
from chibi_git.exception import Git_not_initiate
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class Git:
|
|
9
|
+
def __init__( self, path ):
|
|
10
|
+
self._path = path
|
|
11
|
+
|
|
12
|
+
@property
|
|
13
|
+
def has_git( self ):
|
|
14
|
+
try:
|
|
15
|
+
Git_command.rev_parse( src=self._path ).run()
|
|
16
|
+
except Result_error as e:
|
|
17
|
+
raise Git_not_initiate(
|
|
18
|
+
f"repository in '{self._path}' is not initialize" ) from e
|
|
19
|
+
return True
|
|
20
|
+
|
|
21
|
+
def init( self ):
|
|
22
|
+
try:
|
|
23
|
+
self.has_git
|
|
24
|
+
raise NotImplementedError
|
|
25
|
+
except Git_not_initiate:
|
|
26
|
+
Git_command.init( src=self._path ).run()
|
|
27
|
+
|
|
28
|
+
@property
|
|
29
|
+
def status( self ):
|
|
30
|
+
if not self.has_git:
|
|
31
|
+
raise NotImplementedError
|
|
32
|
+
status = Git_command.status( src=self._path ).run()
|
|
33
|
+
return status.result
|
|
34
|
+
|
|
35
|
+
def add( self, file ):
|
|
36
|
+
result = Git_command.add( file, src=self._path ).run()
|
|
37
|
+
|
|
38
|
+
def commit( self, message ):
|
|
39
|
+
result = Git_command.commit( message, src=self._path ).run()
|
|
40
|
+
|
|
41
|
+
def reset( self ):
|
|
42
|
+
raise NotImplementedError
|
|
43
|
+
|
|
44
|
+
@property
|
|
45
|
+
def is_dirty( self ):
|
|
46
|
+
result = bool( self.status.modified or self.status.renamed )
|
|
47
|
+
return result
|
|
48
|
+
|
|
49
|
+
@property
|
|
50
|
+
def path( self ):
|
|
51
|
+
return Chibi_path( self._path )
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
from chibi_command import Command, Command_result
|
|
2
|
+
from chibi_atlas import Chibi_atlas
|
|
3
|
+
from chibi.file import Chibi_path
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class Status_result( Command_result ):
|
|
7
|
+
def parse_result( self ):
|
|
8
|
+
lines = self.result.split( '\n' )
|
|
9
|
+
lines = list( map( str.strip, lines ) )
|
|
10
|
+
#files = lines[1:]
|
|
11
|
+
result = Chibi_atlas()
|
|
12
|
+
untrack = list( filter( lambda x: x.startswith( "??" ), lines ) )
|
|
13
|
+
modified = list( filter( lambda x: x.startswith( "M" ), lines ) )
|
|
14
|
+
result.untrack = untrack
|
|
15
|
+
result.modified = modified
|
|
16
|
+
self.result = result
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
class Git( Command ):
|
|
20
|
+
command = 'git'
|
|
21
|
+
captive = True
|
|
22
|
+
|
|
23
|
+
@classmethod
|
|
24
|
+
def rev_parse( cls, src=None ):
|
|
25
|
+
command = cls._build_command( 'rev-parse', src=src )
|
|
26
|
+
return command
|
|
27
|
+
|
|
28
|
+
@classmethod
|
|
29
|
+
def init( cls, src=None ):
|
|
30
|
+
command = cls._build_command( 'init', src=src )
|
|
31
|
+
return command
|
|
32
|
+
|
|
33
|
+
@classmethod
|
|
34
|
+
def status( cls, src=None ):
|
|
35
|
+
command = cls._build_command(
|
|
36
|
+
'status', '-sb', src=src, result_class=Status_result )
|
|
37
|
+
return command
|
|
38
|
+
|
|
39
|
+
@classmethod
|
|
40
|
+
def add( cls, file, src=None ):
|
|
41
|
+
command = cls._build_command( 'add', file, src=src, )
|
|
42
|
+
return command
|
|
43
|
+
|
|
44
|
+
@classmethod
|
|
45
|
+
def commit( cls, message, src=None ):
|
|
46
|
+
command = cls._build_command( 'commit', '-m', message, src=src, )
|
|
47
|
+
return command
|
|
48
|
+
|
|
49
|
+
@classmethod
|
|
50
|
+
def _build_command( cls, *args, src=None, **kw ):
|
|
51
|
+
if src:
|
|
52
|
+
src = Chibi_path( src )
|
|
53
|
+
else:
|
|
54
|
+
src = Chibi_path( '.' )
|
|
55
|
+
command = cls(
|
|
56
|
+
f'--git-dir={src}/.git', f'--work-tree={src}',
|
|
57
|
+
*args, **kw )
|
|
58
|
+
return command
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
|
+
Name: chibi_git
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: wrapper to use git in python
|
|
5
|
+
Home-page: https://github.com/dem4ply/chibi_git
|
|
6
|
+
Author: dem4ply
|
|
7
|
+
Author-email: dem4ply@gmail.com
|
|
8
|
+
License: WTFPL
|
|
9
|
+
Keywords: chibi_git
|
|
10
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: License :: Public Domain
|
|
13
|
+
Classifier: Natural Language :: English
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
16
|
+
License-File: LICENSE
|
|
17
|
+
License-File: AUTHORS.rst
|
|
18
|
+
Dynamic: author
|
|
19
|
+
Dynamic: author-email
|
|
20
|
+
Dynamic: classifier
|
|
21
|
+
Dynamic: description
|
|
22
|
+
Dynamic: home-page
|
|
23
|
+
Dynamic: keywords
|
|
24
|
+
Dynamic: license
|
|
25
|
+
Dynamic: summary
|
|
26
|
+
|
|
27
|
+
=========
|
|
28
|
+
Chibi_git
|
|
29
|
+
=========
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
.. image:: https://img.shields.io/pypi/v/chibi_git.svg
|
|
33
|
+
:target: https://pypi.python.org/pypi/chibi_git
|
|
34
|
+
|
|
35
|
+
.. image:: https://readthedocs.org/projects/chibi-git/badge/?version=latest
|
|
36
|
+
:target: https://chibi-git.readthedocs.io/en/latest/?badge=latest
|
|
37
|
+
:alt: Documentation Status
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
wrapper to use git in python
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
* Free software: WTFPL
|
|
46
|
+
* Documentation: https://chibi-git.readthedocs.io.
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
Features
|
|
50
|
+
--------
|
|
51
|
+
|
|
52
|
+
* TODO
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
=======
|
|
56
|
+
History
|
|
57
|
+
=======
|
|
58
|
+
|
|
59
|
+
0.0.1 (2025-01-22)
|
|
60
|
+
------------------
|
|
61
|
+
|
|
62
|
+
* First release on PyPI.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
AUTHORS.rst
|
|
2
|
+
CONTRIBUTING.rst
|
|
3
|
+
HISTORY.rst
|
|
4
|
+
LICENSE
|
|
5
|
+
MANIFEST.in
|
|
6
|
+
README.rst
|
|
7
|
+
setup.cfg
|
|
8
|
+
setup.py
|
|
9
|
+
chibi_git/__init__.py
|
|
10
|
+
chibi_git/chibi_git.py
|
|
11
|
+
chibi_git/commnad.py
|
|
12
|
+
chibi_git/exception.py
|
|
13
|
+
chibi_git.egg-info/PKG-INFO
|
|
14
|
+
chibi_git.egg-info/SOURCES.txt
|
|
15
|
+
chibi_git.egg-info/dependency_links.txt
|
|
16
|
+
chibi_git.egg-info/not-zip-safe
|
|
17
|
+
chibi_git.egg-info/top_level.txt
|
|
18
|
+
docs/Makefile
|
|
19
|
+
docs/authors.rst
|
|
20
|
+
docs/conf.py
|
|
21
|
+
docs/contributing.rst
|
|
22
|
+
docs/history.rst
|
|
23
|
+
docs/index.rst
|
|
24
|
+
docs/installation.rst
|
|
25
|
+
docs/make.bat
|
|
26
|
+
docs/readme.rst
|
|
27
|
+
docs/usage.rst
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
chibi_git
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Minimal makefile for Sphinx documentation
|
|
2
|
+
#
|
|
3
|
+
|
|
4
|
+
# You can set these variables from the command line.
|
|
5
|
+
SPHINXOPTS =
|
|
6
|
+
SPHINXBUILD = python -msphinx
|
|
7
|
+
SPHINXPROJ = chibi_git
|
|
8
|
+
SOURCEDIR = .
|
|
9
|
+
BUILDDIR = _build
|
|
10
|
+
|
|
11
|
+
# Put it first so that "make" without argument is like "make help".
|
|
12
|
+
help:
|
|
13
|
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
14
|
+
|
|
15
|
+
.PHONY: help Makefile
|
|
16
|
+
|
|
17
|
+
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
18
|
+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
19
|
+
%: Makefile
|
|
20
|
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.. include:: ../AUTHORS.rst
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
#!/usr/bin/env python
|
|
2
|
+
# -*- coding: utf-8 -*-
|
|
3
|
+
import os
|
|
4
|
+
import sys
|
|
5
|
+
sys.path.insert(0, os.path.abspath('..'))
|
|
6
|
+
|
|
7
|
+
import chibi_git
|
|
8
|
+
|
|
9
|
+
# -- General configuration ---------------------------------------------
|
|
10
|
+
|
|
11
|
+
# If your documentation needs a minimal Sphinx version, state it here.
|
|
12
|
+
#
|
|
13
|
+
# needs_sphinx = '1.0'
|
|
14
|
+
|
|
15
|
+
# Add any Sphinx extension module names here, as strings. They can be
|
|
16
|
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
17
|
+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
|
|
18
|
+
|
|
19
|
+
# Add any paths that contain templates here, relative to this directory.
|
|
20
|
+
templates_path = ['_templates']
|
|
21
|
+
|
|
22
|
+
# The suffix(es) of source filenames.
|
|
23
|
+
# You can specify multiple suffix as a list of string:
|
|
24
|
+
#
|
|
25
|
+
# source_suffix = ['.rst', '.md']
|
|
26
|
+
source_suffix = '.rst'
|
|
27
|
+
|
|
28
|
+
# The master toctree document.
|
|
29
|
+
master_doc = 'index'
|
|
30
|
+
|
|
31
|
+
# General information about the project.
|
|
32
|
+
project = u'Chibi_git'
|
|
33
|
+
copyright = u"2025, dem4ply"
|
|
34
|
+
author = u"dem4ply"
|
|
35
|
+
|
|
36
|
+
# The version info for the project you're documenting, acts as replacement
|
|
37
|
+
# for |version| and |release|, also used in various other places throughout
|
|
38
|
+
# the built documents.
|
|
39
|
+
#
|
|
40
|
+
# The short X.Y version.
|
|
41
|
+
version = chibi_git.__version__
|
|
42
|
+
# The full version, including alpha/beta/rc tags.
|
|
43
|
+
release = chibi_git.__version__
|
|
44
|
+
|
|
45
|
+
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
46
|
+
# for a list of supported languages.
|
|
47
|
+
#
|
|
48
|
+
# This is also used if you do content translation via gettext catalogs.
|
|
49
|
+
# Usually you set "language" from the command line for these cases.
|
|
50
|
+
language = None
|
|
51
|
+
|
|
52
|
+
# List of patterns, relative to source directory, that match files and
|
|
53
|
+
# directories to ignore when looking for source files.
|
|
54
|
+
# This patterns also effect to html_static_path and html_extra_path
|
|
55
|
+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
56
|
+
|
|
57
|
+
# The name of the Pygments (syntax highlighting) style to use.
|
|
58
|
+
pygments_style = 'sphinx'
|
|
59
|
+
|
|
60
|
+
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
61
|
+
todo_include_todos = False
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
# -- Options for HTML output -------------------------------------------
|
|
65
|
+
|
|
66
|
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
67
|
+
# a list of builtin themes.
|
|
68
|
+
#
|
|
69
|
+
html_theme = 'alabaster'
|
|
70
|
+
|
|
71
|
+
# Theme options are theme-specific and customize the look and feel of a
|
|
72
|
+
# theme further. For a list of options available for each theme, see the
|
|
73
|
+
# documentation.
|
|
74
|
+
#
|
|
75
|
+
# html_theme_options = {}
|
|
76
|
+
|
|
77
|
+
# Add any paths that contain custom static files (such as style sheets) here,
|
|
78
|
+
# relative to this directory. They are copied after the builtin static files,
|
|
79
|
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
80
|
+
html_static_path = ['_static']
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
# -- Options for HTMLHelp output ---------------------------------------
|
|
84
|
+
|
|
85
|
+
# Output file base name for HTML help builder.
|
|
86
|
+
htmlhelp_basename = 'chibi_gitdoc'
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
# -- Options for LaTeX output ------------------------------------------
|
|
90
|
+
|
|
91
|
+
latex_elements = {
|
|
92
|
+
# The paper size ('letterpaper' or 'a4paper').
|
|
93
|
+
#
|
|
94
|
+
# 'papersize': 'letterpaper',
|
|
95
|
+
|
|
96
|
+
# The font size ('10pt', '11pt' or '12pt').
|
|
97
|
+
#
|
|
98
|
+
# 'pointsize': '10pt',
|
|
99
|
+
|
|
100
|
+
# Additional stuff for the LaTeX preamble.
|
|
101
|
+
#
|
|
102
|
+
# 'preamble': '',
|
|
103
|
+
|
|
104
|
+
# Latex figure (float) alignment
|
|
105
|
+
#
|
|
106
|
+
# 'figure_align': 'htbp',
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
# Grouping the document tree into LaTeX files. List of tuples
|
|
110
|
+
# (source start file, target name, title, author, documentclass
|
|
111
|
+
# [howto, manual, or own class]).
|
|
112
|
+
latex_documents = [
|
|
113
|
+
(master_doc, 'chibi_git.tex',
|
|
114
|
+
u'Chibi_git Documentation',
|
|
115
|
+
u'dem4ply', 'manual'),
|
|
116
|
+
]
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
# -- Options for manual page output ------------------------------------
|
|
120
|
+
|
|
121
|
+
# One entry per manual page. List of tuples
|
|
122
|
+
# (source start file, name, description, authors, manual section).
|
|
123
|
+
man_pages = [
|
|
124
|
+
(master_doc, 'chibi_git',
|
|
125
|
+
u'Chibi_git Documentation',
|
|
126
|
+
[author], 1)
|
|
127
|
+
]
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
# -- Options for Texinfo output ----------------------------------------
|
|
131
|
+
|
|
132
|
+
# Grouping the document tree into Texinfo files. List of tuples
|
|
133
|
+
# (source start file, target name, title, author,
|
|
134
|
+
# dir menu entry, description, category)
|
|
135
|
+
texinfo_documents = [
|
|
136
|
+
(master_doc, 'chibi_git',
|
|
137
|
+
u'Chibi_git Documentation',
|
|
138
|
+
author,
|
|
139
|
+
'chibi_git',
|
|
140
|
+
'One line description of project.',
|
|
141
|
+
'Miscellaneous'),
|
|
142
|
+
]
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.. include:: ../CONTRIBUTING.rst
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.. include:: ../HISTORY.rst
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
Welcome to Chibi_git's documentation!
|
|
2
|
+
======================================
|
|
3
|
+
|
|
4
|
+
.. toctree::
|
|
5
|
+
:maxdepth: 2
|
|
6
|
+
:caption: Contents:
|
|
7
|
+
|
|
8
|
+
readme
|
|
9
|
+
installation
|
|
10
|
+
usage
|
|
11
|
+
modules
|
|
12
|
+
contributing
|
|
13
|
+
authors
|
|
14
|
+
history
|
|
15
|
+
|
|
16
|
+
Indices and tables
|
|
17
|
+
==================
|
|
18
|
+
* :ref:`genindex`
|
|
19
|
+
* :ref:`modindex`
|
|
20
|
+
* :ref:`search`
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
.. highlight:: shell
|
|
2
|
+
|
|
3
|
+
============
|
|
4
|
+
Installation
|
|
5
|
+
============
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
Stable release
|
|
9
|
+
--------------
|
|
10
|
+
|
|
11
|
+
To install Chibi_git, run this command in your terminal:
|
|
12
|
+
|
|
13
|
+
.. code-block:: console
|
|
14
|
+
|
|
15
|
+
$ pip install chibi_git
|
|
16
|
+
|
|
17
|
+
This is the preferred method to install Chibi_git, as it will always install the most recent stable release.
|
|
18
|
+
|
|
19
|
+
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
|
|
20
|
+
you through the process.
|
|
21
|
+
|
|
22
|
+
.. _pip: https://pip.pypa.io
|
|
23
|
+
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
From sources
|
|
27
|
+
------------
|
|
28
|
+
|
|
29
|
+
The sources for Chibi_git can be downloaded from the `Github repo`_.
|
|
30
|
+
|
|
31
|
+
You can either clone the public repository:
|
|
32
|
+
|
|
33
|
+
.. code-block:: console
|
|
34
|
+
|
|
35
|
+
$ git clone git://github.com/dem4ply/chibi_git
|
|
36
|
+
|
|
37
|
+
Or download the `tarball`_:
|
|
38
|
+
|
|
39
|
+
.. code-block:: console
|
|
40
|
+
|
|
41
|
+
$ curl -OJL https://github.com/dem4ply/chibi_git/tarball/master
|
|
42
|
+
|
|
43
|
+
Once you have a copy of the source, you can install it with:
|
|
44
|
+
|
|
45
|
+
.. code-block:: console
|
|
46
|
+
|
|
47
|
+
$ python setup.py install
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
.. _Github repo: https://github.com/dem4ply/chibi_git
|
|
51
|
+
.. _tarball: https://github.com/dem4ply/chibi_git/tarball/master
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
@ECHO OFF
|
|
2
|
+
|
|
3
|
+
pushd %~dp0
|
|
4
|
+
|
|
5
|
+
REM Command file for Sphinx documentation
|
|
6
|
+
|
|
7
|
+
if "%SPHINXBUILD%" == "" (
|
|
8
|
+
set SPHINXBUILD=python -msphinx
|
|
9
|
+
)
|
|
10
|
+
set SOURCEDIR=.
|
|
11
|
+
set BUILDDIR=_build
|
|
12
|
+
set SPHINXPROJ=chibi_git
|
|
13
|
+
|
|
14
|
+
if "%1" == "" goto help
|
|
15
|
+
|
|
16
|
+
%SPHINXBUILD% >NUL 2>NUL
|
|
17
|
+
if errorlevel 9009 (
|
|
18
|
+
echo.
|
|
19
|
+
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
|
|
20
|
+
echo.then set the SPHINXBUILD environment variable to point to the full
|
|
21
|
+
echo.path of the 'sphinx-build' executable. Alternatively you may add the
|
|
22
|
+
echo.Sphinx directory to PATH.
|
|
23
|
+
echo.
|
|
24
|
+
echo.If you don't have Sphinx installed, grab it from
|
|
25
|
+
echo.http://sphinx-doc.org/
|
|
26
|
+
exit /b 1
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
|
30
|
+
goto end
|
|
31
|
+
|
|
32
|
+
:help
|
|
33
|
+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
|
34
|
+
|
|
35
|
+
:end
|
|
36
|
+
popd
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.. include:: ../README.rst
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[bumpversion]
|
|
2
|
+
current_version = 0.0.1
|
|
3
|
+
commit = True
|
|
4
|
+
tag = True
|
|
5
|
+
|
|
6
|
+
[bumpversion:file:setup.py]
|
|
7
|
+
search = version='{current_version}'
|
|
8
|
+
replace = version='{new_version}'
|
|
9
|
+
|
|
10
|
+
[bumpversion:file:chibi_git/__init__.py]
|
|
11
|
+
search = __version__ = '{current_version}'
|
|
12
|
+
replace = __version__ = '{new_version}'
|
|
13
|
+
|
|
14
|
+
[bdist_wheel]
|
|
15
|
+
universal = 1
|
|
16
|
+
|
|
17
|
+
[flake8]
|
|
18
|
+
exclude = docs
|
|
19
|
+
|
|
20
|
+
[aliases]
|
|
21
|
+
|
|
22
|
+
[pycodestyle]
|
|
23
|
+
ignore = E202, E201, W503
|
|
24
|
+
max-line-length = 79
|
|
25
|
+
|
|
26
|
+
[egg_info]
|
|
27
|
+
tag_build =
|
|
28
|
+
tag_date = 0
|
|
29
|
+
|
chibi_git-0.0.1/setup.py
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
#!/usr/bin/env python
|
|
2
|
+
# -*- coding: utf-8 -*-
|
|
3
|
+
from setuptools import setup, find_packages
|
|
4
|
+
|
|
5
|
+
with open('README.rst') as readme_file:
|
|
6
|
+
readme = readme_file.read()
|
|
7
|
+
|
|
8
|
+
with open('HISTORY.rst') as history_file:
|
|
9
|
+
history = history_file.read()
|
|
10
|
+
|
|
11
|
+
requirements = []
|
|
12
|
+
|
|
13
|
+
setup(
|
|
14
|
+
author="dem4ply",
|
|
15
|
+
author_email='dem4ply@gmail.com',
|
|
16
|
+
classifiers=[
|
|
17
|
+
'Development Status :: 2 - Pre-Alpha',
|
|
18
|
+
'Intended Audience :: Developers',
|
|
19
|
+
'License :: Public Domain',
|
|
20
|
+
'Natural Language :: English',
|
|
21
|
+
'Programming Language :: Python :: 3.7',
|
|
22
|
+
'Programming Language :: Python :: 3.8',
|
|
23
|
+
],
|
|
24
|
+
description="wrapper to use git in python",
|
|
25
|
+
install_requires=requirements,
|
|
26
|
+
license="WTFPL",
|
|
27
|
+
long_description=readme + '\n\n' + history,
|
|
28
|
+
include_package_data=True,
|
|
29
|
+
keywords='chibi_git',
|
|
30
|
+
name='chibi_git',
|
|
31
|
+
packages=find_packages(include=['chibi_git', 'chibi_git.*']),
|
|
32
|
+
url='https://github.com/dem4ply/chibi_git',
|
|
33
|
+
version='0.0.1',
|
|
34
|
+
zip_safe=False,
|
|
35
|
+
)
|