update documentation and get ready for a quick fix

Author: chfw

.gitignore

@@ -540,3 +540,7 @@ cscope.files
 cscope.out
 cscope.in.out
 cscope.po.out
+
+
+# remove moban hash dictionary
+.moban.hashes

CHANGELOG.rst

@@ -1,6 +1,13 @@
 Change log
 ================================================================================
 
+0.0.4 - 10.11.2024
+--------------------------------------------------------------------------------
+
+**Added**
+
+#. fix github protocol timeout problem
+
 0.0.3 - 11.12.2019
 --------------------------------------------------------------------------------
 

README.rst

@@ -11,11 +11,17 @@ gitfs2
    :target: https://pypi.org/project/gitfs2
 
 .. image:: https://pepy.tech/badge/gitfs2/month
-   :target: https://pepy.tech/project/gitfs2/month
+   :target: https://pepy.tech/project/gitfs2
 
 .. image:: https://img.shields.io/github/stars/moremoban/gitfs2.svg?style=social&maxAge=3600&label=Star
     :target: https://github.com/moremoban/gitfs2/stargazers
 
+.. image:: https://img.shields.io/static/v1?label=continuous%20templating&message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0&color=blue&style=flat-square
+    :target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects
+
+.. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square
+    :target: https://github.com/psf/black
+
 .. image:: https://dev.azure.com/moremoban/gitfs2/_apis/build/status/moremoban.gitfs2?branchName=master
    :target: https://dev.azure.com/moremoban/gitfs2/_build/latest?definitionId=2&branchName=master
 
@@ -35,7 +41,7 @@ Get a file inside a python package
     >>> import fs
     >>> git_fs = fs.open_fs("git://github.com/moremobans/pypi-mobans.git!/templates")
     >>> git_fs.readtext("_version.py.jj2")
-    '__version__ = "0.0.3"\n__author__ = "C.W."\n'
+    '__version__ = "0.0.4"\n__author__ = "C.W."\n'
 
 
 Get from a different branch
@@ -46,7 +52,7 @@ Get from a different branch
     >>> import fs
     >>> git_fs = fs.open_fs("git://github.com/moremobans/pypi-mobans.git?branch=master!/templates")
     >>> git_fs.read("_version.py.jj2")
-    '__version__ = "0.0.3"\n__author__ = "C.W."\n'
+    '__version__ = "0.0.4"\n__author__ = "C.W."\n'
 
 
 Checkout submodules recursively

changelog.yml

@@ -1,6 +1,12 @@
 name: gitfs2
 organisation: moremoban
 releases:
+- changes:
+  - action: Added
+    details:
+    - "fix github protocol timeout problem"
+  version: 0.0.4
+  date: 10.11.2024
 - changes:
   - action: Added
     details:

gitfs2.yml

@@ -3,9 +3,9 @@ organisation: "moremoban"
 author: "C.W."
 contact: "[email protected]"
 company: "moban dev team"
-version: "0.0.3"
-current_version: "0.0.3"
-release: "0.0.3"
+version: "0.0.4"
+current_version: "0.0.4"
+release: "0.0.4"
 copyright_year: 2019
 license: MIT
 dependencies:

gitfs2/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.0.3"
+__version__ = "0.0.4"
 __author__ = "C.W."

lint.sh

@@ -1,2 +1,2 @@
 pip install flake8
-flake8 . --exclude=.moban.d,docs,setup.py --builtins=unicode,xrange,long
+flake8 --exclude=.moban.d,docs,setup.py   --builtins=unicode,xrange,long .  && python setup.py checkdocs

setup.py

@@ -32,7 +32,7 @@
 
 NAME = "gitfs2"
 AUTHOR = "C.W."
-VERSION = "0.0.3"
+VERSION = "0.0.4"
 EMAIL = "[email protected]"
 LICENSE = "MIT"
 ENTRY_POINTS = {
@@ -44,7 +44,7 @@
     "Python file system 2 over GitPython"
 )
 URL = "https://github.com/moremoban/gitfs2"
-DOWNLOAD_URL = "%s/archive/0.0.3.tar.gz" % URL
+DOWNLOAD_URL = "%s/archive/0.0.4.tar.gz" % URL
 FILES = ["README.rst", "CHANGELOG.rst"]
 KEYWORDS = [
     "python",
@@ -79,13 +79,14 @@
 }
 # You do not need to read beyond this line
 PUBLISH_COMMAND = "{0} setup.py sdist bdist_wheel upload -r pypi".format(sys.executable)
-GS_COMMAND = ("gs gitfs2 v0.0.3 " +
-              "Find 0.0.3 in changelog for more details")
+HERE = os.path.abspath(os.path.dirname(__file__))
+
+GS_COMMAND = ("gease gitfs2 v0.0.4 " +
+              "Find 0.0.4 in changelog for more details")
 NO_GS_MESSAGE = ("Automatic github release is disabled. " +
                  "Please install gease to enable it.")
 UPLOAD_FAILED_MSG = (
     'Upload failed. please run "%s" yourself.' % PUBLISH_COMMAND)
-HERE = os.path.abspath(os.path.dirname(__file__))
 
 
 class PublishCommand(Command):
@@ -131,7 +132,6 @@ def run(self):
     "publish": PublishCommand
 })
 
-
 def has_gease():
     """
     test if github release command is installed

tests/requirements.txt

@@ -3,6 +3,12 @@ mock;python_version<"3"
 codecov
 coverage
 flake8
+black
+isort
+collective.checkdocs
+pygments
+moban
+moban_jinja2_github
 moban
 black;python_version>="3.6"
 isort;python_version>="3.6"