Add pip badges and install instructions.

This commit is contained in:
Elliott Pardee 2018-08-23 07:15:48 -04:00
parent b1abe5632d
commit 74fd53bb43
2 changed files with 33 additions and 24 deletions

55
.idea/workspace.xml generated
View File

@ -1,7 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<project version="4"> <project version="4">
<component name="ChangeListManager"> <component name="ChangeListManager">
<list default="true" id="c8edefbc-71df-41a9-9878-b830c52cd7b5" name="Default Changelist" comment="" /> <list default="true" id="c8edefbc-71df-41a9-9878-b830c52cd7b5" name="Default Changelist" comment="">
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
</list>
<option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" /> <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
<option name="SHOW_DIALOG" value="false" /> <option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" /> <option name="HIGHLIGHT_CONFLICTS" value="true" />
@ -37,14 +40,14 @@
<entry key="Python Console" value="62" /> <entry key="Python Console" value="62" />
<entry key="dummy" value="14" /> <entry key="dummy" value="14" />
<entry key="gitignore" value="1" /> <entry key="gitignore" value="1" />
<entry key="md" value="538" /> <entry key="md" value="591" />
<entry key="py" value="11407" /> <entry key="py" value="11407" />
<entry key="txt" value="122" /> <entry key="txt" value="122" />
</counts> </counts>
</usages-collector> </usages-collector>
<usages-collector id="statistics.file.types.edit"> <usages-collector id="statistics.file.types.edit">
<counts> <counts>
<entry key="Markdown" value="538" /> <entry key="Markdown" value="591" />
<entry key="PLAIN_TEXT" value="137" /> <entry key="PLAIN_TEXT" value="137" />
<entry key="Python" value="11469" /> <entry key="Python" value="11469" />
</counts> </counts>
@ -56,12 +59,12 @@
</component> </component>
<component name="FileEditorManager"> <component name="FileEditorManager">
<leaf> <leaf>
<file pinned="false" current-in-tab="false"> <file pinned="false" current-in-tab="true">
<entry file="file://$PROJECT_DIR$/README.md"> <entry file="file://$PROJECT_DIR$/README.md">
<provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]"> <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
<state split_layout="SPLIT"> <state split_layout="SPLIT">
<first_editor relative-caret-position="92"> <first_editor relative-caret-position="184">
<caret line="4" selection-start-line="3" selection-end-line="4" /> <caret line="8" column="43" selection-start-line="8" selection-start-column="43" selection-end-line="8" selection-end-column="43" />
</first_editor> </first_editor>
<second_editor /> <second_editor />
</state> </state>
@ -77,11 +80,11 @@
</provider> </provider>
</entry> </entry>
</file> </file>
<file pinned="false" current-in-tab="true"> <file pinned="false" current-in-tab="false">
<entry file="file://$PROJECT_DIR$/.gitignore"> <entry file="file://$PROJECT_DIR$/.gitignore">
<provider selected="true" editor-type-id="text-editor"> <provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="107"> <state relative-caret-position="-1388">
<caret line="24" column="4" lean-forward="true" selection-start-line="24" selection-start-column="4" selection-end-line="24" selection-end-column="4" /> <caret line="134" column="7" selection-start-line="134" selection-start-column="7" selection-end-line="134" selection-end-column="7" />
</state> </state>
</provider> </provider>
</entry> </entry>
@ -197,9 +200,9 @@
<option value="$PROJECT_DIR$/src/goarch_api/lectionary.py" /> <option value="$PROJECT_DIR$/src/goarch_api/lectionary.py" />
<option value="$PROJECT_DIR$/src/goarch_api/client.py" /> <option value="$PROJECT_DIR$/src/goarch_api/client.py" />
<option value="$PROJECT_DIR$/src/test_all.py" /> <option value="$PROJECT_DIR$/src/test_all.py" />
<option value="$PROJECT_DIR$/README.md" />
<option value="$PROJECT_DIR$/setup.py" /> <option value="$PROJECT_DIR$/setup.py" />
<option value="$PROJECT_DIR$/.gitignore" /> <option value="$PROJECT_DIR$/.gitignore" />
<option value="$PROJECT_DIR$/README.md" />
</list> </list>
</option> </option>
</component> </component>
@ -227,6 +230,10 @@
<item name="goarch_api" type="462c0819:PsiDirectoryNode" /> <item name="goarch_api" type="462c0819:PsiDirectoryNode" />
<item name="goarch_api" type="462c0819:PsiDirectoryNode" /> <item name="goarch_api" type="462c0819:PsiDirectoryNode" />
</path> </path>
<path>
<item name="goarch_api" type="b2602c69:ProjectViewProjectNode" />
<item name="External Libraries" type="cb654da1:ExternalLibrariesNode" />
</path>
</expand> </expand>
<select /> <select />
</subPane> </subPane>
@ -476,19 +483,13 @@
</state> </state>
</provider> </provider>
</entry> </entry>
<entry file="file://$PROJECT_DIR$/README.md"> <entry file="file://$PROJECT_DIR$/.gitignore">
<provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]"> <provider selected="true" editor-type-id="text-editor">
<state split_layout="SPLIT"> <state relative-caret-position="-1388">
<first_editor relative-caret-position="92"> <caret line="134" column="7" selection-start-line="134" selection-start-column="7" selection-end-line="134" selection-end-column="7" />
<caret line="4" selection-start-line="3" selection-end-line="4" />
</first_editor>
<second_editor />
</state> </state>
</provider> </provider>
</entry> </entry>
<entry file="file://$PROJECT_DIR$/MANIFEST">
<provider selected="true" editor-type-id="text-editor" />
</entry>
<entry file="file://$PROJECT_DIR$/setup.py"> <entry file="file://$PROJECT_DIR$/setup.py">
<provider selected="true" editor-type-id="text-editor"> <provider selected="true" editor-type-id="text-editor">
<state relative-caret-position="230"> <state relative-caret-position="230">
@ -496,10 +497,16 @@
</state> </state>
</provider> </provider>
</entry> </entry>
<entry file="file://$PROJECT_DIR$/.gitignore"> <entry file="file://$PROJECT_DIR$/MANIFEST">
<provider selected="true" editor-type-id="text-editor"> <provider selected="true" editor-type-id="text-editor" />
<state relative-caret-position="107"> </entry>
<caret line="24" column="4" lean-forward="true" selection-start-line="24" selection-start-column="4" selection-end-line="24" selection-end-column="4" /> <entry file="file://$PROJECT_DIR$/README.md">
<provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
<state split_layout="SPLIT">
<first_editor relative-caret-position="184">
<caret line="8" column="43" selection-start-line="8" selection-start-column="43" selection-end-line="8" selection-end-column="43" />
</first_editor>
<second_editor />
</state> </state>
</provider> </provider>
</entry> </entry>

View File

@ -1,8 +1,10 @@
goarch_api goarch_api
=== ===
[![PyPI](https://img.shields.io/pypi/v/nine.svg)](https://pypi.org/project/goarch-api/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Django.svg)](https://pypi.org/project/goarch-api/)
A Python interface for the Greek Orthodox Archdiocese of America's Chapel API. A Python interface for the Greek Orthodox Archdiocese of America's Chapel API.
API used with written permission from GOArch's Department of Internet Ministries. Please seek approval before any use of the program by contacting `internet [at] goarch [dot] org`. API used with written permission from GOArch's Department of Internet Ministries. Please seek approval before any use of the program by contacting `internet [at] goarch [dot] org`.
Install via pip: `pip install goarch_api`
Depends on: requests, lxml (install via pip) Depends on: requests, lxml (install via pip)