Merge branch 'develop'

gi2et/__init__.py

@@ -0,0 +1 @@
+__version__ = '1.1.0'

gi2et/config/docs.py

@@ -2,10 +2,11 @@
 Configuration for docs
 """
 
-# source_link = "https://github.com/[org_name]/gi2et"
-# docs_base_url = "https://[org_name].github.io/gi2et"
-# headline = "App that does everything"
-# sub_heading = "Yes, you got that right the first time, everything"
+source_link = "https://github.com/gaurav-naik/gi2et"
+docs_base_url = "https://gaurav-naik.github.io/gi2et"
+headline = "Get Github Issues into ERPNext Tasks"
+sub_heading = "One way pull and update of Github Issues into ERPNext Tasks"
+long_description = """Pull Github Issues into Project Tasks. Update existing Issues into existing Tasks"""
 
 def get_context(context):
 	context.brand_html = "Gi2Et"

gi2et/docs/contents.html

@@ -0,0 +1,10 @@
+<!-- title: Table of Contents -->
+
+<h1>Table of Contents</h1>
+<br>
+
+{% include "templates/includes/full_index.html" %}
+
+<!-- autodoc -->
+<!-- jinja -->
+<!-- no-breadcrumbs -->

gi2et/docs/contents.py

@@ -0,0 +1,9 @@
+# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
+# See license.txt
+
+from __future__ import unicode_literals
+import frappe
+from frappe.website.utils import get_full_index
+
+def get_context(context):
+	context.full_index = get_full_index(extn = True)

gi2et/docs/index.html

@@ -0,0 +1,63 @@
+<!-- title: Gi2Et: Documentation -->
+<!-- description: Get Github Issues into ERPNext Tasks -->
+<!-- no-breadcrumbs -->
+<style>
+
+</style>
+
+<!-- start-hero -->
+<div class="splash">
+ <div class="container">
+  <div class="col-sm-10 col-sm-offset-1">
+   <div class="jumbotron">
+    <h1>Get Github Issues into ERPNext Tasks</h1>
+    <p>One way pull and update of Github Issues into ERPNext Tasks</p>
+   </div>
+   <div class="section" style="padding-top: 0px; margin-top: -30px;">
+      <div class="fake-browser-frame">
+       <img class="img-responsive browser-image feature-image"
+              src="assets/img/home.png">
+      </div>
+   </div>
+  </div>
+ </div>
+</div>
+<!-- end-hero -->
+
+
+<div class="container">
+ <div class="col-sm-10 col-sm-offset-1">
+  <div class="section">
+      <p>Pull Github Issues into Project Tasks. Update existing Issues into existing Tasks</p>
+
+  </div>
+ </div>
+</div>
+
+
+
+<div class="container">
+ <div class="col-sm-10 col-sm-offset-1">
+  <div class="section" id="install">
+    <h2>Install</h2>
+    <h4>From your site</h4>
+    <p>To install this app, login to your site and click on "Installer". Search for <b>Gi2Et</b> and click on "Install"</p>
+    <h4>Using Bench</h4>
+    <p>Go to your bench folder and setup the new app</p>
+    <pre><code class="sh">$ bench get-app gi2et https://github.com/gaurav-naik/gi2et
+$ bench new-site testsite
+$ bench --site testsite install-app gi2et</code></pre>
+    <p>Login to your site to configure the app.</p>
+    <p><a href="install.html">Detailed Installation Steps</a></p>
+   </div>
+   <div class="section">
+       <h2>Author</h2>
+
+       <p>MN Technique ([email protected])</p>
+   </div>
+ </div>
+</div>
+
+
+<!-- autodoc -->
+<!-- jinja -->

gi2et/docs/index.txt

@@ -0,0 +1,6 @@
+user
+install
+contents
+assets
+license
+current

gi2et/docs/install.md

@@ -0,0 +1,30 @@
+<!-- title: Gi2Et Installation -->
+
+# Installation
+
+Gi2Et is based on the <a href="https://frappe.io">Frappe Framework</a>, a full stack web framework based on Python, MariaDB, Redis, Node.
+
+To intall Gi2Et, you will have to install the <a href="https://github.com/frappe/bench">Frappe Bench</a>, the command-line, package manager and site manager for Frappe Framework. For more details, read the Bench README.
+
+After you have installed Frappe Bench, go to you bench folder, which is     `frappe.bench` by default and setup **gi2et**.
+
+    bench get-app gi2et {{ source_link }}
+
+Then create a new site to install the app.
+
+    bench new-site mysite
+
+This will create a new folder in your `/sites` directory and create a new database for this site.
+
+Next, install gi2et in this site
+
+    bench --site mysite install-app gi2et
+
+To run this locally, run
+
+    bench start
+
+Fire up your browser and go to http://localhost:8000 and you should see the login screen. Login as **Administrator** and **admin** (or the password you set at the time of `new-site`) and you are set.
+
+<!-- jinja -->
+<!-- autodoc -->

gi2et/docs/license.html

@@ -0,0 +1,8 @@
+<!-- title: License GPL v3 -->
+
+<h1>GPL v3</h1>
+
+<p>License: GPL v3</p>
+
+
+<!-- autodoc -->

gi2et/docs/user/gi2et-task-sync.md

@@ -0,0 +1,24 @@
+<!-- title: Gi2Et Task Sync -->
+<!-- no-breadcrumbs -->
+
+Gi2Et Task Sync is a tool accessible from
+
+> Gi2Et > Gi2Et Task Sync
+
+
+####Steps to Pull and Update Tasks
+
+
+<img class="screenshot" alt="Gi2Et Task Sync" src="{{ docs_base_url }}/assets/img/gi2et-task-sync.png">
+<ul>
+ <li><strong>Select Project</strong>: Project must have associated Github Repository. Project's Github Repository has to be set in Project</li>
+ <li><strong>Get Issues</strong>: Click this button to pull / update github issues</li>
+ <li><strong>Github Issues</strong>: All the github issues related to the project repository will be pulled into this table. Do not edit table manually.</li>
+ <li><strong>Generate Tasks</strong>: Click the button to generate new tasks or update existing ones</li>
+</ul>
+
+{next}
+
+<!-- autodoc -->
+<!-- jinja -->
+<!-- static -->

gi2et/docs/user/index.html

@@ -0,0 +1,16 @@
+<!-- title: Gi2Et: User Docs -->
+<!-- no-breadcrumbs -->
+<p>
+Gi2Et is Frappe app for pulling and updating Github Issues into ERPNext Tasks. It is to be used along with ERPNext.
+</p>
+<p>
+It creates a desk icon for the module. In this module, there is Gi2Et Task Sync Tool and one Setup section for setting Personal Github API Token.
+</p>
+
+<h3>Contents</h3>
+
+{index}
+
+<!-- autodoc -->
+<!-- jinja -->
+<!-- static -->

gi2et/docs/user/index.txt

@@ -0,0 +1,2 @@
+gi2et-task-sync
+setup

gi2et/docs/user/setup/gi2et-settings.md

@@ -0,0 +1,21 @@
+<!-- title: Gi2Et Settings -->
+<!-- no-breadcrumbs -->
+
+Gi2Et Settings sets personal Github API Token required to get authenticated access to Github API.
+
+> Gi2Et > Gi2Et Settings
+
+
+####Set Personal Github API token here.
+
+
+<img class="screenshot" alt="Worker Sheet Settings" src="{{ docs_base_url }}/assets/img/gi2et-settings.png">
+<ul>
+ <li><strong>API Token</strong>: Enter API Token Secret Key here. Generate API Token on Github's Settings</li>
+</ul>
+
+{next}
+
+<!-- autodoc -->
+<!-- jinja -->
+<!-- static -->

gi2et/docs/user/setup/index.md

@@ -0,0 +1,3 @@
+### Topics
+
+{index}

gi2et/docs/user/setup/index.txt

@@ -0,0 +1,2 @@
+gi2et-settings
+

gi2et/hooks.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
+from . import __version__ as app_version
 
 app_name = "gi2et"
 app_title = "Gi2Et"
@@ -8,7 +9,6 @@
 app_icon = "octicon octicon-mark-github"
 app_color = "#87cefa"
 app_email = "[email protected]"
-app_version = "1.0.0"
 app_license = "GPL v3"
 
 fixtures = ["Custom Field"]

setup.py

@@ -1,8 +1,15 @@
 # -*- coding: utf-8 -*-
 from setuptools import setup, find_packages
 from pip.req import parse_requirements
+import re, ast
+
+# get version from __version__ variable in gi2et/__init__.py
+_version_re = re.compile(r'__version__\s+=\s+(.*)')
+
+with open('gi2et/__init__.py', 'rb') as f:
+	version = str(ast.literal_eval(_version_re.search(
+		f.read().decode('utf-8')).group(1)))
 
-version = '1.0.0'
 requirements = parse_requirements("requirements.txt", session="")
 
 setup(