Skip to content

Commit

Permalink
Remove incubator references and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanpadams committed Jun 18, 2020
1 parent 352bdc3 commit bb3cf62
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 46 deletions.
52 changes: 13 additions & 39 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,9 @@ Features
Installation
============

First, this requires Python 3.6, 3.7, or 3.8. Are you still using Python 2? It
reached end-of-life on January 1st, 2020_.

Make a virtualenv_ and run ``pip install pds-deep-archive`` into it. Or use a buildout_
or, if you absolutely must, install it into your system python you monster.
This software depends on the lxml_ library which your Python installer should
take care of, but your *system* will require ``libxml2`` 2.9.2 or later as
well as ``libxsl2`` 1.1.28 or later.

1. Download the tar.gz distribution

2. Create a virtualenv and activate::

bash> mkdir -p $HOME/.virtualenvs
bash> virtualenv $HOME/.virtualenvs/pds-deep-archive
bash> $HOME/.virtualenvs/pds-deep-archive/bin/activate

3. Use the downloaded tar.gz from step 1 and pip to install pds-deep-archive and all of its dependencies::

(pds-deep-archive) bash> pip install pds.deeparchive-0.0.0.tar.gz
See the online documentation for Installation_ instructions

4. You should now be able to run the deep archive utilities::
You should then be able to run the deep archive utilities::

(pds-deep-archive) bash> pds-deep-archive --help
(pds-deep-archive) bash> aipgen --help
Expand All @@ -52,24 +33,13 @@ well as ``libxsl2`` 1.1.28 or later.
Build
=====

To build the software for distribution:

1. Boostrap the buildout (if needed)::

bash> python3 bootstrap.py
bash> bin/buildout

2. Create an install package::

bash> buildout setup . sdist

3. A tar.gz should now be available in the ``dist/`` directory for distribution.
See the Development_Guide_ for more information.


Documentation
=============

Installation and Usage information can be found in the documentation online at https://nasa-pds-incubator.github.io/pds-deep-archive/ or the latest version is maintained under the ``docs`` directory.
Installation and Usage information can be found in the documentation online at https://nasa-pds.github.io/pds-deep-archive/ or the latest version is maintained under the ``docs`` directory.



Expand All @@ -82,16 +52,17 @@ This product has not been translated into any other languages than US English.
Contribute
==========

• Issue Tracker: https://github.com/NASA-PDS-Incubator/pds-deep-archive/issues
• Source Code: https://github.com/NASA-PDS-Incubator/pds-deep-archive
• Wiki: https://github.com/NASA-PDS-Incubator/pds-deep-archive/wiki
• Issue Tracker: https://github.com/NASA-PDS/pds-deep-archive/issues
• Source Code: https://github.com/NASA-PDS/pds-deep-archive
• Wiki: https://github.com/NASA-PDS/pds-deep-archive/wiki


Support
=======

If you are having issues, please let us know. You can reach us at
https://pds.nasa.gov/?feedback=true
If you are having issues file a bug report in Github: https://github.com/NASA-PDS/pds-deep-archive/issues

Or you can reach us at https://pds.nasa.gov/?feedback=true


License
Expand All @@ -107,6 +78,9 @@ LICENSE.txt file for details.
.. _PDS: https://pds.nasa.gov/
.. _virtualenv: https://docs.python.org/3/library/venv.html
.. _lxml: https://lxml.de/
.. _Installation: https://nasa-pds.github.io/pds-deep-archive/installation/
.. _Development_Guide: https://nasa-pds.github.io/pds-deep-archive/development/



.. Copyright © 2019–2020 California Institute of Technology ("Caltech").
Expand Down
8 changes: 4 additions & 4 deletions docs/source/development/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
The quickest way to get started developing this package is to clone it and
build it out::

git clone https://github.com/NASA-PDS-Incubator/pds-deep-archive.git
git clone https://github.com/NASA-PDS/pds-deep-archive.git
cd pds-deep-archive
python3 bootstrap.py
bin/buildout
Expand Down Expand Up @@ -61,7 +61,7 @@ and enter the release version number you'd like to appear when running the
commands with ``--version`` and on the official Python Package Index. Commit
and push this, then, on GitHub (and with appropriate permissions), visit:

https://github.com/NASA-PDS-Incubator/pds-deep-archive/releases/new
https://github.com/NASA-PDS/pds-deep-archive/releases/new

and enter a release tag with the same version number plus any release notes.
This will trigger a GitHub Actions release to the official PyPI 🤞.
Expand All @@ -84,12 +84,12 @@ To deploy to the official PyPi manually:
Contribute
----------

Source Code: https://github.com/NASA-PDS-Incubator/pds-deep-archive
Source Code: https://github.com/NASA-PDS/pds-deep-archive


.. _reStructuredText: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/en/master/
.. _testing: https://test.pypi.org/
.. _Actions: https://github.com/features/actions
.. _website: https://nasa-pds-incubator.github.io/pds-deep-archive/
.. _website: https://nasa-pds.github.io/pds-deep-archive/
.. _Jenkins: https://jenkins-ci.org/
2 changes: 1 addition & 1 deletion docs/source/support/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ Found a bug? Or want a new feature? We would love your feedback and
contributions. Please submit new issues into our repository Github Issue
Tracking:

Issue Tracking: https://github.com/NASA-PDS-Incubator/pds-deep-archive/issues
Issue Tracking: https://github.com/NASA-PDS/pds-deep-archive/issues

4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@
setup(
name='pds.deeparchive',
version=version,
description='SIP Generator',
description='PDS Deep Archive software for generating OAIS AIPs and SIPs for PDS4 Archives.',
long_description=readme + '\n\n' + changes,
keywords='PDS CCSDS OAIS AIP SIP metadata submission archive package',
author='Sean Kelly',
author_email='sean.kelly@jpl.nasa.gov',
url='https://github.com/NASA-PDS-Incubator/pds-deep-archive/',
url='https://github.com/NASA-PDS/pds-deep-archive/',
entry_points={
'console_scripts': [
'sipgen=pds.aipgen.sip:main',
Expand Down

0 comments on commit bb3cf62

Please sign in to comment.