Skip to content

Commit

Permalink
General repository cleanup:
Browse files Browse the repository at this point in the history
- Sort out setuptools config with regard to package data
- Replace occurences of "spacetelescope" with "asdf-format"
- Update README.rst to be standard RST and remove parsing code from setup.py
- Replace use of deprecated numpy.ndarray.tostring() with numpy.ndarray.tobinary()
- Fix Travis MacOS build
- Remove license statements from source files
- Update package metadata
  • Loading branch information
Ed Slavich committed Jul 8, 2020
1 parent 453d7a7 commit ea6b8b6
Show file tree
Hide file tree
Showing 98 changed files with 133 additions and 446 deletions.
6 changes: 6 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,9 @@ matrix:
os: osx
language: shell
before_install:
- brew unlink python@2
- brew install [email protected]
install: pip3 install tox

# Test on Windows
- env:
Expand All @@ -107,6 +109,10 @@ matrix:

- env: TOXENV=warnings

# This build frequently fails due to timeout
- env: TOXENV=s390x
arch: s390x

install: pip install tox

script: tox
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Spacetelescope Open Source Code of Conduct
# asdf-format Open Source Code of Conduct

We expect all "spacetelescope" organization projects to adopt a code of conduct
We expect all "asdf-format" organization projects to adopt a code of conduct
that ensures a productive, respectful environment for all open source
contributors and participants. We are committed to providing a strong and
enforced code of conduct and expect everyone in our community to follow these
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ protected and used for official releases. The rest of the branches are for
release maintenance and should not be used normally. Unless otherwise told by a
maintainer, pull request should be made and submitted to the "master" branch.

New to github or open source projects? If you are unsure about where to start or
haven't used github before, please feel free to contact the package maintainers.
New to GitHub or open source projects? If you are unsure about where to start or
haven't used GitHub before, please feel free to contact the package maintainers.

Feedback and feature requests? Is there something missing you would like to see?
Please open an issue or send an email to the maintainers. This package follows
the Spacetelescope `Code of Conduct<CODE_OF_CONDUCT.md>`_ strives to provide a
the asdf-format `Code of Conduct<CODE_OF_CONDUCT.md>`_ and strives to provide a
welcoming community to all of our users and contributors.
2 changes: 1 addition & 1 deletion licenses/LICENSE.rst → LICENSE.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2019, Space Telescope Science Institute
Copyright (c) 2020, Space Telescope Science Institute
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Expand Down
26 changes: 2 additions & 24 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,29 +1,7 @@
include README.rst
include CHANGES.rst

include ez_setup.py
include ah_bootstrap.py
include setup_helpers.py
include setup.cfg

recursive-include *.pyx *.c *.pxd
recursive-include docs *
recursive-include licenses *
recursive-include cextern *
recursive-include scripts *
recursive-include asdf-standard/schemas *.yaml
recursive-include asdf-standard/reference_files *

# Python version specific compatibility packages, normally excluded by default
# depending on the Python version doing the building
recursive-include asdf/compat *.py

prune build
prune docs/_build
prune docs/api

recursive-include astropy_helpers *
exclude astropy_helpers/.git
exclude astropy_helpers/.gitignore
global-exclude *.pyc

global-exclude *.pyc *.o
exclude .*
77 changes: 34 additions & 43 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,21 @@
..
ASDF - Advanced Scientific Data Format
======================================
.. raw:: html

<p align="center">
<img src="docs/_static/stsci_logo.png" alt="STScI Logo">
</p>
<h1 align="center">ASDF - Advanced Scientific Data Format</h1>
<p align="center">
<a href="https://travis-ci.org/spacetelescope/asdf"><img src="https://travis-ci.org/spacetelescope/asdf.svg?branch=master" alt="Build Status"></a>
<a href="http://asdf.readthedocs.io/en/latest/?badge=latest"><img src="https://readthedocs.org/projects/asdf/badge/?version=latest" alt="Documentation Status"></a>
<a href="https://codecov.io/gh/spacetelescope/asdf"><img src="https://codecov.io/gh/spacetelescope/asdf/branch/master/graphs/badge.svg" alt="Coverage Status"></a>
<img src="https://img.shields.io/pypi/l/asdf.svg" alt="license">
<a href="http://www.stsci.edu"><img src="https://img.shields.io/badge/powered%20by-STScI-blue.svg?colorA=707170&colorB=3e8ddd&style=flat" alt="stsci"></a>
<a href="http://www.astropy.org/"><img src="http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat" alt="astropy"></a>
</p>
<p align="center">
<a href="#overview">Overview</a> •
<a href="#installation">Installation</a> •
<a href="#testing">Testing</a> •
<a href="#documentation">Documentation</a> •
<a href="#contributing">Contributing</a>
</p>

.. _begin-summary-text
ASDF - Advanced Scientific Data Format
======================================

.. image:: https://travis-ci.com/asdf-format/asdf.svg?branch=master
:target: https://travis-ci.com/asdf-format/asdf

.. image:: https://readthedocs.org/projects/asdf/badge/?version=latest
:target: https://asdf.readthedocs.io/en/latest/

.. image:: https://codecov.io/gh/asdf-format/asdf/branch/master/graphs/badge.svg
:target: https://codecov.io/gh/asdf-format/asdf

.. image:: https://img.shields.io/pypi/l/asdf.svg
:target: https://img.shields.io/pypi/l/asdf.svg

|
.. _begin-summary-text:

The **A**\ dvanced **S**\ cientific **D**\ ata **F**\ ormat (ASDF) is a
next-generation interchange format for scientific data. This package
Expand All @@ -44,10 +35,10 @@ The ASDF format has the following features:
serialized automatically
* ASDF can be extended to serialize custom data types

.. _end-summary-text
.. _end-summary-text:

ASDF is under active development `on github
<https://github.com/spacetelescope/asdf>`__. More information on contributing
<https://github.com/asdf-format/asdf>`__. More information on contributing
can be found `below <#contributing>`__.

Overview
Expand All @@ -59,7 +50,7 @@ and reading ASDF files.
Creating a file
~~~~~~~~~~~~~~~

.. _begin-create-file-text
.. _begin-create-file-text:

We're going to store several `numpy` arrays and other data to an ASDF file. We
do this by creating a "tree", which is simply a `dict`, and we provide it as
Expand Down Expand Up @@ -100,7 +91,7 @@ of ASDF on display:
%YAML 1.1
%TAG ! tag:stsci.edu:asdf/
--- !core/asdf-1.1.0
asdf_library: !core/software-1.0.0 {author: Space Telescope Science Institute, homepage: 'http://github.com/spacetelescope/asdf',
asdf_library: !core/software-1.0.0 {author: The ASDF Developers, homepage: 'http://github.com/asdf-format/asdf',
name: asdf, version: 2.0.0}
history:
extensions:
Expand Down Expand Up @@ -142,12 +133,12 @@ It is possible to compress the array data when writing the file:
Available compression algorithms are ``'zlib'``, ``'bzp2'``, and
``'lz4'``.

.. _end-create-file-text
.. _end-create-file-text:

Reading a file
~~~~~~~~~~~~~~

.. _begin-read-file-text
.. _begin-read-file-text:

To read an existing ASDF file, we simply use the top-level `open` function of
the `asdf` package:
Expand All @@ -173,8 +164,8 @@ attribute:
>>> import asdf
>>> af = asdf.open('example.asdf')
>>> af.tree
{'asdf_library': {'author': 'Space Telescope Science Institute',
'homepage': 'http://github.com/spacetelescope/asdf',
{'asdf_library': {'author': 'The ASDF Developers',
'homepage': 'http://github.com/asdf-format/asdf',
'name': 'asdf',
'version': '1.3.1'},
'foo': 42,
Expand Down Expand Up @@ -222,7 +213,7 @@ option of `open` when reading:
af = asdf.open('example.asdf', copy_arrays=True)
.. _end-read-file-text
.. _end-read-file-text:

For more information and for advanced usage examples, see the
`documentation <#documentation>`__.
Expand All @@ -239,7 +230,7 @@ documentation <http://asdf.readthedocs.io/en/latest/asdf/extensions.html>`__.
Installation
------------

.. _begin-pip-install-text
.. _begin-pip-install-text:

Stable releases of the ASDF Python package are registered `at
PyPi <https://pypi.python.org/pypi/asdf>`__. The latest stable version
Expand All @@ -249,14 +240,14 @@ can be installed using ``pip``:

$ pip install asdf

.. _begin-source-install-text
.. _begin-source-install-text:

The latest development version of ASDF is available from the ``master`` branch
`on github <https://github.com/spacetelescope/asdf>`__. To clone the project:
`on github <https://github.com/asdf-format/asdf>`__. To clone the project:

::

$ git clone https://github.com/spacetelescope/asdf
$ git clone https://github.com/asdf-format/asdf

To install:

Expand All @@ -281,12 +272,12 @@ mode <https://packaging.python.org/tutorials/distributing-packages/#working-in-d
submodules <https://git-scm.com/docs/git-submodule>`__ for more
information.

.. _end-source-install-text
.. _end-source-install-text:

Testing
-------

.. _begin-testing-text
.. _begin-testing-text:

To install the test dependencies from a source checkout of the repository:

Expand Down Expand Up @@ -332,7 +323,7 @@ To run a specific environment:
$ tox -e <envname>


.. _end-testing-text
.. _end-testing-text:

Documentation
-------------
Expand Down
4 changes: 0 additions & 4 deletions asdf/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-


"""
asdf: Python library for reading and writing Advanced Scientific
Data Format (ASDF) files
Expand Down
4 changes: 0 additions & 4 deletions asdf/_internal_init.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-


__all__ = ['__version__', '__githash__', 'test']


Expand Down
8 changes: 2 additions & 6 deletions asdf/asdf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-


import io
import os
import time
Expand Down Expand Up @@ -40,8 +36,8 @@ def get_asdf_library_info():
return Software({
'name': 'asdf',
'version': version.version,
'homepage': 'http://github.com/spacetelescope/asdf',
'author': 'Space Telescope Science Institute'
'homepage': 'http://github.com/asdf-format/asdf',
'author': 'The ASDF Developers'
})


Expand Down
3 changes: 0 additions & 3 deletions asdf/asdftypes.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

import warnings

from .exceptions import AsdfDeprecationWarning
Expand Down
3 changes: 0 additions & 3 deletions asdf/block.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

import copy
import hashlib
import io
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

import importlib

from .exploded import implode, explode
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/defragment.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

"""
Defragment command.
"""
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/diff.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

"""
Implementation of command for displaying differences between two ASDF files.
"""
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/exploded.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

"""
Contains commands for dealing with exploded and imploded forms.
"""
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/extension.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

"""
Implementation of command for reporting information about installed extensions.
"""
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/extract.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

"""
Implementation of command for converting ASDF-in-FITS to standalone ASDF file.
"""
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/main.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# -*- coding: utf-8 -*-
# Licensed under a 3-clause BSD style license - see LICENSE.rst

import argparse
import logging
import sys
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/remove_hdu.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

"""
Implementation of command for removing ASDF HDU from ASDF-in-FITS file.
"""
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/tags.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

"""
Implementation of command for displaying available tags in asdf
"""
Expand Down
2 changes: 0 additions & 2 deletions asdf/commands/tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +0,0 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-
1 change: 0 additions & 1 deletion asdf/commands/tests/data/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
3 changes: 0 additions & 3 deletions asdf/commands/tests/test_defragment.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

import os

import numpy as np
Expand Down
4 changes: 0 additions & 4 deletions asdf/commands/tests/test_diff.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-


import io
from functools import partial

Expand Down
4 changes: 0 additions & 4 deletions asdf/commands/tests/test_exploded.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-


import os

import numpy as np
Expand Down
3 changes: 0 additions & 3 deletions asdf/commands/tests/test_extract.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-

import os

import numpy as np
Expand Down
Loading

0 comments on commit ea6b8b6

Please sign in to comment.