DOC: unpublished/linkeddata: pep-XXX-linked-data-json-ld-rdf-rdfa.rst

unpublished/linkeddata/Makefile

@@ -0,0 +1,14 @@
+
+# Makefile
+#
+
+default: build
+
+build: build-pep-XXX
+
+build-pep-XXX:
+	# ./pep-XXX-linked-data-json-ld-rdf-rdfa.rst > HTML
+	rst2html.py ./pep-XXX-linked-data-json-ld-rdf-rdfa.rst > pep-XXX-linked-data-json-ld-rdf-rdfa.rst.html
+
+open:
+	web ./pep-XXX-linked-data-json-ld-rdf-rdfa.rst.html

unpublished/linkeddata/pep-XXX-linked-data-json-ld-rdf-rdfa.rst

@@ -0,0 +1,298 @@
+PEP: XXX
+Title: Linked Metadata for Python Software Packages
+Version: $Revision$
+Last-Modified: $Date$
+Author: Wes Turner <wes.turner@gmail.com>
+BDFL-Delegate: -
+Discussions-To: GitHub: https://github.com/pypa/interoperability-peps/issues/31 , Distutils SIG <distutils-sig@python.org>
+Keywords: PEP426JSONLD, RDF, RDFa, JSON-LD, JSONLD, LinkedData, Linked
+Data
+Status: Draft
+Type: Standards Track (?)
+Content-Type: text/x-rst
+Requires: 440, 426 (?)
+Created: 1 Dec 2015
+Post-History:
+Replaces: 345 (?)
+
+
+.. contents::
+
+Abstract
+========
+
+This PEP describes a mechanism for publishing and exchanging metadata
+related to Python distributions. It includes specifics of the field names,
+and their semantics and usage.
+
+* Version 1.0 is specified in PEP 241.
+* Version 1.1 is specified in PEP 314.
+* Version 1.2 is specified in PEP 345.
+  PEP 345 is to be considered the current (2015) packaging
+  metadata format.
+
+* Version 2.0 (draft) is specified in PEP 426.
+  PEP426 would/will significantly modify the JSON metadata
+  format; adding additional fields for e.g. source code metadata
+  and semantic dependencies.
+
+* Version 3.0 (1.2 + [2.0] + Linked Data) (draft)
+  is specified in this document.
+
+  For purposes of practicality, because PEP 426 is still draft,
+  this PEP will strive to transform first Version 1.2 PEP 345 metadata
+  and then Version 2.0 (draft) PEP 426 metadata into `JSON-LD`_ (and
+  thereby `RDF`_).
+
+Version 3.0 Would Require
+
+* metadata.json (Version 1.2 (345), Version 2.0 (426))
+* metadata.jsonld (in addition to the existing metadata.json)
+
+  * [ ] lookup-optimized JSON metadata keys -> JSON-LD ``@context``
+
+* schema.pypa.io JSONLD ``@context``
+
+  *
+
+
+Definitions
+==============
+
+Linked Data
+    Linked Data is data linked with URIs; preferably in a format
+    that is transformable to or already RDF (such as RDFa, JSON-LD,
+    Turtle/Trig)
+
+    * The Linked Data glossary contains
+      term definitions for many Linked Data Concepts [`LD-GLOSSARY`_].
+
+URI
+    A URI (*Uniform Resource Indicator*) is a namespaced
+    string with structured parts and delimiters
+    for naming or identifying a resource.
+
+    TODO: example
+
+URN
+    TODO: example
+
+URL
+    A URL (*Uniform Resource Locator*) is a **URI**
+    identifying a retrievable resource.
+
+
+RDF
+    RDF (*Resource Description Framework*) [`RDF`_]
+
+RDFa
+    RDFa (*RDF-in-attributes*) is an open W3C format for including
+    structured data inline with (presentational) HTML pages.
+
+    * Search engines can and do parse RDFa (particularly with schema.org
+      types and property/attribute/column URIs)
+
+JSON-LD
+    JSON-LD (*JSON Linked Data*) is a format TODO [`JSON-LD`_,
+    `JSON-LD-1.0`_]
+
+Schema.org
+    `<schema.org>`__ is a standard RDFS vocabulary of classes and
+    properties for many different domains.
+
+    * schema.org is maintained as RDFa; other formats are generated from
+      the source RDFa representation.
+
+      TODO: link
+
+    * schema.org supports an extension vocabulary model; suggesting
+      ``schema.[domain.tld]`` for URI namespaces and ``schema<...>:``
+      for URI QNames (and URI CURIES).
+
+      TODO: link
+
+
+schema.org/SoftwareApplication
+    + http://schema.org/SoftwareApplication
+
+schema.org/Code
+    + http://schema.org/Code
+
+
+
+Features / Use Cases / TODO
+=============================
+
+Version 3.0 Would Enable
+
+* `Python Packaging RDF`_
+
+  * [ ] schema.pypa.io (a ``gh-pages`` branch. sphinx?)
+
+* [ ] Warehouse: metadata.jsonld extraction & indexing
+* [ ] Warehouse: JSONLD HTTP GET views:
+  https://warehouse.python.org/project/pip/jsonld
+
+* [ ] Warehouse: JSONLD in the package [release] template:
+  https://warehouse.python.org/project/pip
+
+  .. code:: html
+
+      <script type="application/ld+json">
+      {"@context": {...},
+       "@graph": {
+      }}
+      </script>
+
+* [ ] Warehouse: RDFa in the package [release] template:
+  https://warehouse.python.org/project/pip
+
+* Dependency Graph Metadata Traversals
+
+  * `pip-tools`_
+
+    * ``pip-compile`` compiles a ``requirements.in`` file to a
+      ``requirements.txt`` file with explicitly pinned dependencies.
+    * ``pip-sync`` installs and upgrades a `virtualenv`_
+
+Venv
+    Python 3.TODO includes venv (``python3 -m venv``)
+    which performs many of the functions of `virtualenv`_
+
+virtualenv
+    virtualenv creates prefixed containerized sets of [Python]
+    dependencies.
+
+    * **schemapy:packages**
+
+      | domain: Venv > [ Virtualenv, VirtualenvwrapperVirtualenv ]
+      | range: SoftwarePackage > [ PythonPackage , ]
+      | @type: @list
+
+      A virtualenv contains zero or more packages
+      (e.g. [pip, setuptools, wheel] and whatever has been copied into
+      the ``VIRTUAL_ENV/lib/pythonX.X/site-packages`` directory
+      prepended to ``sys.path``).
+
+    * **schemapy:system-site-packages**
+
+      | domain: Venv
+      | range: schema:Boolean (xsd:bool), schema:URL (xsd:string, rdfs:Resource)
+
+      A virtualenv is configured to use ``system-site-packages``
+      if there is a ``no-global-site-packages.txt`` file
+      in the ``site-packages`` directory (e.g. at
+      ``VIRTUAL_ENV/lib/pythonX.X/site-packages/no-global-site-packages.txt``)
+
+      * The `virtualenvwrapper toggleglobalsitepackages`_ shell function
+        adds or removes a ``no-global-site-packages.txt`` file
+        in a given `virtualenv`_ (which is otherwise configured at
+        creation time; now, by default to ``--no-system-site-packages``,
+        requiring a virtualenv to be created with
+        ``--system-site-packages`` in order to omit the
+        ``no-global-site-packages.txt`` file).
+
+Python Packaging RDF
+========================
+| xmlns: https://schema.pypa.io
+| xmlns: ``schemapy:``
+
+* @type: SoftwarePackage
+
+  * @type: PythonPackage
+
+* @type: PythonPackageRelease
+
+  * @type: Sdist
+  * @type: Bdist
+  * @type: Egg
+  * @type: Wheel
+  * @type: [Conda]
+
+* @type: Requirement
+
+  * :name: 
+  * :versionspec: / :version:
+  * @type: PythonPackageRequirement
+
+* @type: Constraint
+
+* @type: PackageRepo
+
+  * @type: PythonPackageRepo
+
+    * @type: HostedPythonPackageRepo
+
+      * eg: `PyPI`_
+      * eg: `Warehouse`_
+      * eg: [`DevPi`_]
+
+* @type: Venv
+
+  * [:host/] :path
+  * :packages
+
+  * @type: Virtualenv
+
+    * @type: VirtualenvwrapperVirtualenv
+
+      * :PROJECT_HOME
+      * :WORKON_HOME
+
+
+
+References
+============
+
+============================
+Python Packaging References
+============================
+
+.. [1] reStructuredText markup:
+   http://docutils.sourceforge.net/
+
+.. [PyPI] http://pypi.python.org/pypi/
+
+.. [Warehouse] https://warehouse.python.org/
+
+.. [devpi] https://pypi.python.org/pypi/devpi
+
+.. [pip-tools] https://github.com/nvie/pip-tools
+
+.. [virtualenv] https://pypi.python.org/pypi/virtualenv
+
+.. _virtualenvwrapper toggleglobalsitepackages: https://virtualenvwrapper.readthedocs.org/en/latest/command_ref.html#toggleglobalsitepackages
+
+.. _virtualenvwrapper toggleglobalsitepackages source:
+   https://bitbucket.org/dhellmann/virtualenvwrapper/src/4.7.0/virtualenvwrapper.sh#virtualenvwrapper.sh-926
+
+=======================
+Linked Data References
+=======================
+
+.. [JSON-LD] http://json-ld.org
+
+.. [JSON-LD-1.0] http://www.w3.org/TR/json-ld/ 
+
+.. [LINKED-DATA] https://en.wikipedia.org/wiki/Linked_data
+
+.. [LD-GLOSSARY] https://www.w3.org/TR/ld-glossary/
+
+.. [RDF] http://www.w3.org/TR/rdf11-primer/
+
+.. [RDF-Concepts] http://www.w3.org/TR/rdf11-concepts/
+
+
+Copyright
+=========
+
+This document has been placed in the public domain.
+
+
+..
+   Local Variables:
+   mode: indented-text
+   indent-tabs-mode: nil
+   sentence-end-double-space: t
+   fill-column: 70
+   End:

unpublished/linkeddata/schema/schema.pypa.io-latest.context.jsonld

@@ -0,0 +1 @@
+./schema.pypa.io-v0.1.0.context.jsonld