Add basic documentation

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

AUTHORS.rst

@@ -1,3 +1,3 @@
 The following organizations or individuals have contributed to this repo:
 
-- 
+- nexB Inc.

CHANGELOG.rst

@@ -5,4 +5,4 @@ Changelog
 v0.0.0
 ------
 
-*xxxx-xx-xx* -- Initial release.
+Initial release.

NOTICE

@@ -2,7 +2,8 @@
 # Copyright (c) nexB Inc. and others.
 # SPDX-License-Identifier: Apache-2.0
 #
-# Visit https://aboutcode.org and https://github.com/nexB/ for support and download.
+# Visit https://aboutcode.org and https://github.com/nexB/python-inspector
+# for support and download.
 # ScanCode is a trademark of nexB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

README.rst

@@ -1,59 +1,47 @@
-A Simple Python Project Skeleton
-================================
-This repo attempts to standardize the structure of the Python-based project's
-repositories using modern Python packaging and configuration techniques. 
-Using this `blog post`_ as inspiration, this repository serves as the base for
-all new Python projects and is mergeable in existing repositories as well.
+python-inspector - inspect Python packages dependencies and metadata
+=====================================================================
 
-.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/
 
+Copyright (c) nexB Inc. and others.
+SPDX-License-Identifier: Apache-2.0
+Homepage: https://github.com/nexB/python-inspector and https://www.aboutcode.org/
 
-Usage
-=====
 
-A brand new project
--------------------
-.. code-block:: bash
+``python-inspector`` is a collection of utilities to:
 
-    git init my-new-repo
-    cd my-new-repo
-    git pull [email protected]:nexB/skeleton
+- resolve PyPI packages dependencies
 
-    # Create the new repo on GitHub, then update your remote
-    git remote set-url origin [email protected]:nexB/your-new-repo.git
+- parse various manifests and packages files such as pip requirement files,
+  Pipfile, pyproject.toml, poetry.lock, setup.py and setup.cfg and legacy and
+  current metadata file formats for eggs, wheels and sdist.
 
-From here, you can make the appropriate changes to the files for your specific project.
+- query PyPI JSON and simple APIs for package information
 
-Update an existing project
----------------------------
-.. code-block:: bash
+It grew out of ScanCode toolkit to find and analyze PyPI archives and
+installed Python packages and their files.
 
-    cd my-existing-project
-    git remote add skeleton [email protected]:nexB/skeleton
-    git fetch skeleton
-    git merge skeleton/main --allow-unrelated-histories
+The goal of python-inspector is to be a comprehensive library
+that can handle every style of Python package layouts, manifests and lockfiles.
 
-This is also the workflow to use when updating the skeleton files in any given repository.
 
-More usage instructions can be found in ``docs/skeleton-usage.rst``.
+Its companion libraries are:
 
+- ``pip-requirements-parser``, a mostly correct pip requirements parsing
+  library extracted from pip.
 
-Release Notes
-=============
+- ``pkginfo2``, a safer fork of pkginfo to parse various installed and extracted
+  package layouts and their metadata files.
 
-- 2022-03-04:
-    - Synchronize configure and configure.bat scripts for sanity
-    - Update CI operating system support with latest Azure OS images
-    - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party dependencies
-      There are now fewer scripts. See etc/scripts/README.rst for details
+- ``dparse2``, a safer fork of dparse to parse various package manifests
 
-- 2021-09-03:
-    - ``configure`` now requires pinned dependencies via the use of ``requirements.txt`` and ``requirements-dev.txt``
-    - ``configure`` can now accept multiple options at once
-    - Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files
-    - Rename virtual environment directory from ``tmp`` to ``venv``
-    - Update README.rst with instructions for generating ``requirements.txt`` and ``requirements-dev.txt``,
-      as well as collecting dependencies as wheels and generating ABOUT files for them.
+- ``resolvelib``, the library used by pip for dependency resolution
 
-- 2021-05-11:
-    - Adopt new configure scripts from ScanCode TK that allows correct configuration of which Python version is used.
+- ``packaging``, the official Python packaging utility library to process
+  versions, specifiers, markers  and other packaging data formats.
+
+- ``importlib_metadata``, the official Python utility library to process
+  installed site-packages and their metadata formats.
+
+- ``packageurl-python`` to use Package URL to reference Python packages
+ 
+