Skip to content

Commit

Permalink
Move to pyvideo
Browse files Browse the repository at this point in the history
  • Loading branch information
logston committed Aug 20, 2016
1 parent 2081e30 commit 42dfe43
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .schemas/category.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"The schema for a category of videos in pytube/data",
"description":"The schema for a category of videos in pyvideo/data",
"properties":{
"alias":{
"description":"[Deprecated] Legacy path to category on pyvideo.org",
Expand Down
2 changes: 1 addition & 1 deletion .schemas/video.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"The schema for a video record in pytube/data",
"description":"The schema for a video record in pyvideo/data",
"properties":{
"alias":{
"description":"[Deprecated] Legacy path to video on pyvideo.org",
Expand Down
20 changes: 10 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Adding Data
JSON Objects
~~~~~~~~~~~~

Each video contributed to `pytube/data`_ must have its own JSON object
Each video contributed to `pyvideo/data`_ must have its own JSON object
containing details about the video.
For example, here's a JSON object containing data about a talk at PyGotham 2015::

Expand Down Expand Up @@ -89,7 +89,7 @@ tags array of strings
================================== ================================== ==================================

For a full schema of a video JSON object, please see
https://github.com/pytube/data/blob/master/.schemas/video.json
https://github.com/pyvideo/data/blob/master/.schemas/video.json

.. _ISO 639-3: https://en.wikipedia.org/wiki/ISO_639-3

Expand All @@ -104,7 +104,7 @@ other information about the video.

The description string for a video must be a valid reStructuredText (rST)
document. That is, the string keyed by "description" in a JSON object must be
parsible by a reStructuredText (rST) parser. `pytube/data`_ uses docutils'
parsible by a reStructuredText (rST) parser. `pyvideo/data`_ uses docutils'
``docutils.parsers.rst.Parser`` to test the validity of the description and
summary strings for each video.

Expand Down Expand Up @@ -143,7 +143,7 @@ Pretty print is important! In order to maintain this data with ease,
it needs to be easily parseable by the human eye. Thus, all contributions are
requested to be in pretty-printed format. Thankfully, Python makes this an easy task.
To convert a single file of ugly JSON to a file of pretty JSON, you can use the
following command from the root of your local clone of the `pytube/data`_ repo::
following command from the root of your local clone of the `pyvideo/data`_ repo::

$ python tools/reserialize.py path/to/file.json

Expand Down Expand Up @@ -188,24 +188,24 @@ key value type
title string
================================== ==================================

For a full schema of a category JSON object, please see https://github.com/pytube/data/blob/master/.schemas/category.json
For a full schema of a category JSON object, please see https://github.com/pyvideo/data/blob/master/.schemas/category.json

Pull Request
~~~~~~~~~~~~

Once your video JSON files and category JSON file are ready to be added to
pytube's collection, take the following steps:
pyvideo's collection, take the following steps:

#. Fork this repo if you haven't already.
#. Clone from your forked repo.
#. Add your category directory (containing the JSON files) into the root of the repo.
#. Add yourself as a contributor in the `CONTRIBUTORS.rst <https://github.com/pytube/data/blob/master/CONTRIBUTORS.rst>`_ file.
#. Add yourself as a contributor in the `CONTRIBUTORS.rst <https://github.com/pyvideo/data/blob/master/CONTRIBUTORS.rst>`_ file.
#. Commit your changes and push them up to your fork.
#. Issue a Pull Request of your changes to this repo.

And you're done! So long as you've followed this guide, your Pull Request (PR)
should be ready for review and merger. Your changes will be visible on
pytube.org within a few days after the PR is merged.
pyvideo.org within a few days after the PR is merged.

Cleaning Data
-------------
Expand All @@ -218,7 +218,7 @@ Reporting Bugs

Report bugs at:

https://github.com/pytube/data/issues
https://github.com/pyvideo/data/issues

If you are reporting a bug about incorrect data, please include:

Expand Down Expand Up @@ -258,4 +258,4 @@ articles, tweets and other things like that.

**Thanks so much for contributing to your worldwide Python community!**

.. _`pytube/data`: https://github.com/pytube/data
.. _`pyvideo/data`: https://github.com/pyvideo/data
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export PYTHONPATH := $(BASEDIR):$(TESTSDIR)
VERBOSE ?= 0

help:
@echo 'Makefile for a testing pytube/data '
@echo 'Makefile for a testing pyvideo/data '
@echo ' '
@echo 'Usage: '
@echo ' make test run all tests '
Expand Down
17 changes: 7 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,27 @@
pytube/data
pyvideo/data
===========

*Python related videos and metadata*

.. image:: https://badges.gitter.im/pytube/data.svg
:alt: Join the chat at https://gitter.im/pytube/data
:target: https://gitter.im/pytube/data?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. image:: https://zenodo.org/badge/23288/pytube/data.svg
:target: https://zenodo.org/badge/latestdoi/23288/pytube/data
.. image:: https://badges.gitter.im/pyvideo/data.svg
:alt: Join the chat at https://gitter.im/pyvideo/data
:target: https://gitter.im/pyvideo/data?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

**Publishing**

`NO_PUBLISH.json <https://github.com/pytube/data/blob/master/NO_PUBLISH.json>`_
`NO_PUBLISH.json <https://github.com/pyvideo/data/blob/master/NO_PUBLISH.json>`_

Please do not publish to any video hosting site any of the videos whose IDs are in this list.
Some speakers/video owners have reached out and requested that their videos
not be published. Such videos are listed in this file by ID.

**Contributing**

Contribution guide: `CONTRIBUTING.rst <https://github.com/pytube/data/blob/master/CONTRIBUTING.rst>`_
Contribution guide: `CONTRIBUTING.rst <https://github.com/pyvideo/data/blob/master/CONTRIBUTING.rst>`_

**Contributors**

List of contributors: `CONTRIBUTORS.rst <https://github.com/pytube/data/blob/master/CONTRIBUTORS.rst>`_
List of contributors: `CONTRIBUTORS.rst <https://github.com/pyvideo/data/blob/master/CONTRIBUTORS.rst>`_
Thanks everybody in this list!

**Copying**
Expand Down
2 changes: 1 addition & 1 deletion tools/edit_rest.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@


EDITOR = os.environ.get('EDITOR', 'vim')
URL_REPO='https://github.com/pytube/data/blob/master/'
URL_REPO='https://github.com/pyvideo/data/blob/master/'


def get_edited_text(original_text):
Expand Down

0 comments on commit 42dfe43

Please sign in to comment.