Skip to content

Commit

Permalink
Readme + Index Updated
Browse files Browse the repository at this point in the history
Requirements added
Gitignore Updated
  • Loading branch information
DEKHTIARJonathan committed Aug 11, 2017
1 parent b2f0324 commit 1c4bac2
Show file tree
Hide file tree
Showing 5 changed files with 101 additions and 59 deletions.
2 changes: 2 additions & 0 deletions .gitignore
@@ -0,0 +1,2 @@
venv/
build/
70 changes: 70 additions & 0 deletions README.md
@@ -0,0 +1,70 @@
FeedCrunch.IO - DJANGO APP
====================
[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
[![GPL Licence](https://badges.frapsoft.com/os/gpl/gpl.svg?v=103)](https://opensource.org/licenses/GPL-3.0/)
[![Build Status](https://travis-ci.com/DEKHTIARJonathan/FeedCrunch.IO.svg?token=Mwzs9s5gJEGyrsnoybN5&branch=master)](https://travis-ci.com/DEKHTIARJonathan/FeedCrunch.IO)
[![Dependency Status](https://beta.gemnasium.com/badges/github.com/DEKHTIARJonathan/FeedCrunch.IO.svg)](https://beta.gemnasium.com/projects/github.com/DEKHTIARJonathan/FeedCrunch.IO)
[![ReadTheDocs](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat&maxAge=86400)](http://feedcrunch.readthedocs.io/en/latest/)

## Installation

Rename the file ".env.dist" to ".env"
```sh
mv .env.dist .env
```

Then please update the file ".env" with the correct values.

If needed, you can generate a secret key for DJANGO here: http://www.miniwebtool.com/django-secret-key-generator/

```sh
pip install virtualenv
virtualenv venv

## Windows
venv\Scripts\activate.bat

## Linux
source venv/bin/activate

pip install -r requirements.txt
```

## Launching Server

```sh
python manage.py runserver 0.0.0.0:5000
```

Launching Tests

```sh
coverage run manage.py test
coverage report -m
coverage html
```

## Travis with AWS CodeDeploy

You will need to set environment variables as followed:

| Key | Value |
|--------------------------|----------------------------------------------------------------------------------------------------------|
| TRAVIS | True |
| DEBUG | True/False |
| SECRET_KEY | '##############################################' |
| DATABASE_URL | 'postgres://user:password@host:port/Database'<br>(travis: 'postgres://postgres:@localhost:5432/travisci')|
| CODECLIMATE_REPO_TOKEN | '##############################################' |
| AWS_ACCESS_KEY_ID | '##############################################' |
| AWS_SECRET_ACCESS_KEY | '##############################################' |


Options needed to be declared in the Admin Panel :

| Key | Value |
|--------------------------|--------------------------------------------------|
| twitter_consumer_secret | '##############################################' |
| twitter_consumer_key | '##############################################' |
| mailchimp_client_secret | '##############################################' |
| mailchimp_client_id | '##############################################' |
| freemium_period | True/False |
28 changes: 0 additions & 28 deletions README.rst

This file was deleted.

19 changes: 19 additions & 0 deletions requirements.txt
@@ -0,0 +1,19 @@
alabaster==0.7.10
Babel==2.4.0
certifi==2017.7.27.1
chardet==3.0.4
colorama==0.3.9
docutils==0.14
idna==2.5
imagesize==0.7.1
Jinja2==2.9.6
MarkupSafe==1.0
Pygments==2.2.0
pytz==2017.2
requests==2.18.3
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.6.3
sphinx-rtd-theme==0.2.4
sphinxcontrib-websupport==1.0.1
urllib3==1.22
41 changes: 10 additions & 31 deletions source/index.rst
@@ -1,49 +1,28 @@
.. FeedRadar.IO API documentation master file, created by
sphinx-quickstart on Mon Apr 12 23:44:02 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to FeedRadar.IO API's documentation!
Welcome to FeedCrunch.IO API's documentation!
============================================

.. image:: https://readthedocs.org/projects/feedcrunch/badge/?version=latest
:target: http://feedcrunch.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

:Author: Jonathan DEKHTIAR
:Issues: https://github.com/DEKHTIARJonathan/Dataradar-API-Documentation/issues
:Issues: https://github.com/DEKHTIARJonathan/Feedcrunch.io/issues
:License: GNU GPL v3
:Version: |version|
:Generated: |today|
:Version: 1.0
:Generated: July 28, 2017

Introduction
-------------

**FeedRadar.IO** is an **open access** platform created in order to share freely and widely
**FeedCrunch.IO** is an **open access** platform created in order to share freely and widely
ressources concerning data mining, data science, machine learning, computer vision and so on.
I really hope this platform will become a *must-see* for every student in data science and but
also for data analysts and data scientists.

In order to widely open access to the ressources, the platform provides an **API** access.
It's free to use, you just need an API Key which is available upon request at : contact@feedradar.io
It's free to use, you just need an API Key which is available upon request at : contact (at) feedcrunch (dot) io.

If you need any specific method to crawl the platform, feel free to contact me.
I'll be glad to provide some help for your projects.

**Our Motto :** *Keep Sharing and Spreading Knowledge*

.. toctree::
:hidden:
:caption: Introduction

Home <self>
fair_use

.. toctree::
:hidden:
:caption: API Documentation
:titlesonly:

General Information <API/api_doc>
GET article/id <API/article_id>
POST article/add <API/article_add>
GET articles/all <API/articles_all>
GET articles/list <API/articles_list>
GET article/search <API/articles_search>

0 comments on commit 1c4bac2

Please sign in to comment.