Merge pull request #1 from vinta/master

yanglicheng8 · web-flow · commit 4cdf87069c3a · 2018-02-05T18:32:45.000+08:00
拉取最新内容
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+## What is this Python project?
+
+Describe features.
+
+## What's the difference between this Python project and similar ones?
+
+Enumerate comparisons.
+
+--
+
+Anyone who agrees with this pull request could vote for it by adding a :+1: to it, and usually, the maintainer will merge it when votes reach **20**.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,6 @@
 .DS_Store
+
 *.py[co]
+
+docs/index.md
+site/
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.2
+
+before_script:
+  - gem install awesome_bot
+
+script:
+  - awesome_bot README.md --allow-dupe --white-list pyparsing,graphviz.org
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,12 +4,14 @@ Your contributions are always welcome!
 
 ## Guidelines
 
-* Add section if needed.
-    * Add section description.
-    * Add section title to Table of contents.
+* Add one link per Pull Request.
+* Add the link: `* [project-name](http://example.com/) - A short description ends with a period.`
+    * Keep descriptions concise.
+* Add a section if needed.
+    * Add the section description.
+    * Add the section title to Table of Contents.
 * Search previous suggestions before making a new one, as yours may be a duplicate.
-* Add your links: `* [project-name](http://example.com/) - A short description ends with a dot.`
 * Don't mention `Python` in the description as it's implied.
 * Check your spelling and grammar.
-* Make sure your text editor is set to remove trailing whitespace.
-* Send a Pull Request.
+* Remove any trailing whitespace.
+* Send a Pull Request with the reason why the library is awesome.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,15 @@
+BASEDIR=$(CURDIR)
+DOCDIR=$(BASEDIR)/docs
+
+install:
+	pip install mkdocs==0.16.3
+	pip install mkdocs-material==1.12.2
+
+link:
+	ln -sf $(BASEDIR)/README.md $(DOCDIR)/index.md
+
+preview: link
+	mkdocs serve
+
+deploy: link
+	mkdocs gh-deploy --clean
diff --git a/README.md b/README.md
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+awesome-python.com
diff --git a/docs/extra.css b/docs/extra.css
@@ -0,0 +1,37 @@
+.bs-sidebar.well {
+    /* margin-bottom: 0; */
+}
+
+.bs-sidebar .nav > li > a:hover,
+.bs-sidebar .nav > li > a:focus {
+    border: none;
+    border-left: 2px solid;
+}
+
+.bs-sidebar .nav > .active > a,
+.bs-sidebar .nav > .active:hover > a,
+.bs-sidebar .nav > .active:focus > a {
+    border: none;
+    border-left: 2px solid;
+}
+
+@media (min-width: 992px) {
+    .bs-sidebar.affix {
+        /* top: 60px; */
+        /* bottom: 0px; */
+        top: 80px;
+        bottom: 23px;
+        overflow: auto;
+    }
+}
+
+@media (min-width: 1200px) {
+    .bs-sidebar.affix-bottom,
+    .bs-sidebar.affix {
+        width: 280px;
+    }
+
+    .container > .col-md-9 {
+        padding-left: 40px;
+    }
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,25 @@
+site_name: 'Awesome Python'
+site_url: 'https://awesome-python.com'
+site_description: 'A curated list of awesome Python frameworks, libraries and software'
+site_author: 'Vinta Chen'
+repo_name: 'vinta/awesome-python'
+repo_url: 'https://github.com/vinta/awesome-python'
+theme: 'material'
+extra:
+  feature:
+    tabs: false
+  palette:
+    primary: 'red'
+    accent: 'pink'
+  social:
+    - type: 'github'
+      link: 'https://github.com/vinta'
+    - type: 'twitter'
+      link: 'https://twitter.com/vinta'
+    - type: 'linkedin'
+      link: 'https://www.linkedin.com/in/vinta'
+google_analytics:
+  - 'UA-510626-7'
+  - 'auto'
+pages:
+  - "Life is short, you need Python.": "index.md"
diff --git a/sort.py b/sort.py
@@ -13,6 +13,33 @@
     and flattening the end structure into a list of lines. Revision 2 maybe ^.^.
 """
 
+def sort_blocks():
+    # First, we load the current README into memory
+    with open('README.md', 'r') as read_me_file:
+        read_me = read_me_file.read()
+
+    # Separating the 'table of contents' from the contents (blocks)
+    table_of_contents = ''.join(read_me.split('- - -')[0])
+    blocks = ''.join(read_me.split('- - -')[1]).split('\n# ')
+    for i in range(len(blocks)):
+        if i == 0:
+            blocks[i] = blocks[i] + '\n'
+        else:
+            blocks[i] = '# ' + blocks[i] + '\n'
+
+    # Sorting the libraries
+    inner_blocks = sorted(blocks[0].split('##'))
+    for i in range(1 , len(inner_blocks)):
+        if inner_blocks[i][0] != '#':
+            inner_blocks[i] = '##' + inner_blocks[i]
+    inner_blocks=''.join(inner_blocks)
+
+    # Replacing the non-sorted libraries by the sorted ones and gathering all at the final_README file
+    blocks[0] = inner_blocks
+    final_README = table_of_contents + '- - -' + ''.join(blocks)
+
+    with open('README.md', 'w+') as sorted_file:
+        sorted_file.write(final_README)
 
 def main():
     # First, we load the current README into memory as an array of lines
@@ -45,6 +72,9 @@ def main():
         # And the result is written back to README.md
         sorted_file.write(''.join(blocks))
 
+    # Then we call the sorting method
+    sort_blocks()
+
 
 if __name__ == "__main__":
     main()
