Skip to content
This repository was archived by the owner on Aug 28, 2020. It is now read-only.

fixed Travis, converted README and version as file #138

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 0 additions & 95 deletions README.md

This file was deleted.

141 changes: 141 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
.. image:: https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png
:target: https://www.sendgrid.com
:alt: SendGrid Logo

|Build Status| |Email Notifications Badge| |Twitter Follow| |Python Versions| |PyPI Version| |GitHub contributors| |MIT licensed|

**Quickly and easily store data about your open source projects on GitHub and various Package Managers.**

Announcements
=============

**NEW:** If you're a software engineer who is passionate about #DeveloperExperience and/or #OpenSource,
`this is an incredible opportunity to join our #DX team`_
as a Developer Experience Engineer and work with `@thinkingserious`_ and `@aroach`_!
Tell your friends :)

All updates to this project are documented in our `CHANGELOG`_.

Table of Contents
=================

- `Installation <#installation>`__
- `Heroku Deploy <#heroku-deploy>`__
- `Roadmap <#roadmap>`__
- `How to Contribute <#how-to-contribute>`__
- `About <#about>`__
- `License <#license>`__

Installation
============

Environment Variables
---------------------

First, get your free SendGrid account `here`_.

Next, update your environment with your `SENDGRID_API_KEY`_.

Initial Setup
-------------

`Library Usage Documentation`_

If you enabled CSV exports in your ``config.yml``, those files will appear under the ``csv/`` directory in the project repository.

Dependencies
------------

- The SendGrid Service, starting at the `free level`_
- `virtualenv`_
- `mysql`_

Heroku Deploy
=============

.. image:: https://www.herokucdn.com/deploy/button.svg
:target: https://heroku.com/deploy

.. code:: bash

heroku login
heroku create
heroku addons:create cleardb:ignite

Access the cleardb DB and create the tables in ``db/data_schema.sql``

.. code:: bash

heroku config:add ENV=prod
heroku config:add GITHUB_TOKEN=<<your_github_token>>
heroku config:add SENDGRID_API_KEY=<<your_sendgrid_api_key>>
heroku addons:create scheduler:standard

Configure the scheduler add-on in your Heroku dashboard to run ``python app.py`` at your desired frequency.

Test by running ``heroku run worker``

Roadmap
=======

If you are interested in the future direction of this project, please take a look at our `milestones`_.
We would love to hear your feedback.

How to Contribute
=================

We encourage contribution to our projects, please see our `CONTRIBUTING`_ guide for details.

Quick links:

- `Feature Request`_
- `Bug Reports`_
- `Sign the CLA to Create a Pull Request`_
- `Improvements to the Codebase`_

About
=====

**open-source-library-data-collector** is guided and supported by the SendGrid `Developer Experience Team`_.

**open-source-library-data-collector** is maintained and funded by SendGrid, Inc.
The names and logos for **open-source-library-data-collector** are trademarks of SendGrid, Inc.

License
=======

`The MIT License (MIT)`_

.. _this is an incredible opportunity to join our #DX team: https://sendgrid.com/careers/role/1421152/?gh_jid=1421152
.. _@thinkingserious: https://github.com/thinkingserious
.. _@aroach: https://github.com/aroach
.. _CHANGELOG: https://github.com/sendgrid/open-source-library-data-collector/blob/master/CHANGELOG.md
.. _here: https://sendgrid.com/free?source=open-source-data-collector
.. _SENDGRID_API_KEY: https://app.sendgrid.com/settings/api_keys
.. _Library Usage Documentation: https://github.com/sendgrid/open-source-library-data-collector/blob/master/USAGE.md
.. _free level: https://sendgrid.com/free?source=open-source-data-collector
.. _virtualenv: https://pypi.org/project/virtualenv/
.. _mysql: https://www.mysql.com
.. _milestones: https://github.com/sendgrid/open-source-library-data-collector/milestones
.. _CONTRIBUTING: https://github.com/sendgrid/open-source-library-data-collector/blob/master/CONTRIBUTING.md
.. _Feature Request: https://github.com/sendgrid/open-source-library-data-collector/blob/master/CONTRIBUTING.md#feature-request
.. _Bug Reports: https://github.com/sendgrid/open-source-library-data-collector/blob/master/CONTRIBUTING.md#submit-a-bug-report
.. _Sign the CLA to Create a Pull Request: https://github.com/sendgrid/open-source-library-data-collector/blob/master/CONTRIBUTING.md#cla
.. _Improvements to the Codebase: https://github.com/sendgrid/open-source-library-data-collector/blob/master/CONTRIBUTING.md#improvements-to-the-codebase
.. _Developer Experience Team: mailto:[email protected]
.. _The MIT License (MIT): https://github.com/sendgrid/open-source-library-data-collector/blob/master/LICENSE.txt

.. |Build Status| image:: https://travis-ci.org/sendgrid/open-source-library-data-collector.svg?branch=master
:target: https://travis-ci.org/sendgrid/open-source-library-data-collector
.. |Email Notifications Badge| image:: https://dx.sendgrid.com/badge/python
:target: https://dx.sendgrid.com/newsletter/python
.. |Twitter Follow| image:: https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow
:target: https://twitter.com/sendgrid
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/open_source_library_data_collector.svg
:target: https://pypi.org/project/open_source_library_data_collector/
.. |PyPI Version| image:: https://img.shields.io/pypi/v/open_source_library_data_collector.svg
:target: https://pypi.org/project/open_source_library_data_collector/
.. |GitHub contributors| image:: https://img.shields.io/github/contributors/sendgrid/open-source-library-data-collector.svg
:target: https://github.com/sendgrid/open-source-library-data-collector/graphs/contributors
.. |MIT licensed| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/sendgrid/open-source-library-data-collector/blob/master/LICENSE.txt
1 change: 1 addition & 0 deletions VERSION.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.1.0
9 changes: 0 additions & 9 deletions fix_README.py

This file was deleted.

8 changes: 0 additions & 8 deletions register.py

This file was deleted.

19 changes: 11 additions & 8 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
import io
import os
import sys

from setuptools import setup, find_packages

long_description = 'Please see our GitHub README'
if os.path.exists('README.txt'):
long_description = open('README.txt').read()


def getRequires():
deps = ['github3.py',
Expand All @@ -29,18 +26,24 @@ def getRequires():
return deps


base_url = 'https://github.com/sendgrid/'
dir_path = os.path.abspath(os.path.dirname(__file__))
readme = io.open(os.path.join(dir_path, 'README.rst'),
encoding='utf-8').read()
version = io.open(os.path.join(dir_path, 'VERSION.txt'),
encoding='utf-8').read().strip()

setup(
name='open_source_library_data_collector',
version='1.1.0',
version=version,
author='Elmer Thomas',
author_email='[email protected]',
url='{}open-source-library-data-collector'.format(base_url),
url='https://github.com/sendgrid/open-source-library-data-collector',
packages=find_packages(),
include_package_data=True,
license='MIT',
description='Periodically capture external data relating to GitHub hosted '
'Open Source libraries',
long_description=long_description,
long_description=readme,
install_requires=getRequires(),
keywords=[
'GitHub',
Expand Down
3 changes: 2 additions & 1 deletion test/test_repository_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@ def setUp(self):
['./CODE_OF_CONDUCT.md'],
['./CONTRIBUTING.md'],
['./LICENSE.md', './LICENSE.txt'],
['./README.md'],
['./README.rst'],
['./TROUBLESHOOTING.md'],
['./USAGE.md'],
['./USE_CASES.md'],
['./VERSION.txt'],
]

def _file_exists(self, files):
Expand Down