Merge pull request #3 from Princeton-CDH/chore/1-neuxml

Prepare initial release (#1), drop Python < 3.12 and Django support (#2)

Author: blms

.coveragerc

@@ -1,5 +1,5 @@
 [run]
-source = eulxml
+source = neuxml
 
 [report]
 omit =

.github/workflows/python-publish.yml

@@ -0,0 +1,49 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - name: Install pypa/build
+      run: python3 -m pip install build --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  pypi-publish:
+    name: Upload release to PyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/neuxml
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -3,13 +3,13 @@ dist
 *.egg-info
 *.pyc
 test-results
-eulxml/xpath/lextab.py
-eulxml/xpath/parsetab.py
-eulxml/schema_data
+neuxml/xpath/lextab.py
+neuxml/xpath/parsetab.py
 .tox
 .eggs
 .coverage
 .cache
 coverage.xml
 nosetests.xml
-
+venv*
+.DS_Store

.travis.yml

@@ -1,39 +1,16 @@
 language: python
 
 python:
-  - "2.6"
-  - "2.7"
-  - "3.3"
-  - "3.4"
-  - "3.5"
-env:
-  - DJANGO_ENV="Django>=1.5,<1.6"
-  - DJANGO_ENV="Django>=1.6,<1.7"
-  - DJANGO_ENV="Django>=1.7,<1.8"
-  - DJANGO_ENV="Django>=1.8,<1.9"
-
-matrix:
-  exclude:
-  - python: "2.6"
-    env: DJANGO_ENV="Django>=1.7,<1.8"
-  - python: "2.6"
-    env: DJANGO_ENV="Django>=1.8,<1.9"
-  - python: "3.5"
-    env: DJANGO_ENV="Django>=1.5,<1.6"
-  - python: "3.5"
-    env: DJANGO_ENV="Django>=1.6,<1.7"
-  - python: "3.5"
-    env: DJANGO_ENV="Django>=1.7,<1.8"
+  - "3.12"
 
 # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
 install:
-  - pip install $DJANGO_ENV
   - pip install -e .
-  - pip install 'eulxml[dev]'
+  - pip install 'neuxml[dev]'
   - pip install coveralls
 
 script:
-  - nosetests --with-coverage
-
+  - pytest --cov=./ --cov-report=xml
+  
 after_success:
   - coveralls

CHANGELOG.rst

@@ -2,248 +2,14 @@ Change & Version Information
 ============================
 
 The following is a summary of changes and improvements to
-:mod:`eulxml`.  New features in each version should be listed, with
+:mod:`neuxml`.  New features in each version should be listed, with
 any necessary information about installation or upgrade notes.
 
-1.1.3
+0.1.0
 -----
 
-* Require lxml 3.4 for ``collect_ids`` feature used in duplicate id
-  support added in eulxml 1.1.2
-
-1.1.2
------
-
-* Allow duplicate ``xml:ids`` when loading xml if validation is not enabled
-  (`PR #29 <https://github.com/emory-libraries/eulxml/pull/29>`_ from
-  `@lddubeau <https://github.com/lddubeau>`_)
-
-1.1.1
------
-
-* Fix ply version in setup.py so install requirements match setup
-  requirements
-* Only add eulxml catalog file to XML_CATALOG_FILES environment variable
-  once
-
-1.1
----
-
-* Now using an `XML catalog <http://xmlsoft.org/catalog.html>`_
-  to load local copies of XSD schemas referenced by included XmlObject
-  classes.  The included catalog is automatically added to the
-  **XML_CATALOG_FILES** environment variable when eulxml is loaded, and
-  should be used automatically and transparently by lxml and libxml.
-  [`#18 <https://github.com/emory-libraries/eulxml/issues/18>`_]
-* The use of an HTTP PROXY is no longer required for loading schemas,
-  and eulxml will not generate warnings if no proxy is set.
-* New module eulxml.catalog to download schemas and generate an XML
-  catalog
-* Custom setup.py command `xmlcatalog` as a shortcut for downloading
-  schemas and generating an XML Catalog
-* Customized setup.py so that building the package will download
-  schemas and generate a catalog if needed (schema files and xml
-  catalog are now included in package data).
-* The existing CERP schema URL no longer resolves; it has has been
-  replaced with a new url that does, and included in the schema catalog
-* bugfix: serializing unicode within xpaths
-* bugfix: normalize space on eadid value in eulxml.xmlmap.teimap
-* bugfix: xpath serialization error for unicode strings within xpaths
-* bugfix: correction in xpath for TEI interp value
-
-1.0.1
------
-
-* Correct six dependency required version
-* Fix six dependency in eulxml.xpath so installation can complete
-  and generate parsetab and lextab when six installation is not yet
-  processed.  [`#20 <https://github.com/emory-libraries/eulxml/issues/20>`_]
-
-1.0
----
-
-* Now Python 3 compatible, thanks to Morgan Aubert
-  (`@ellmetha <https://github.com/ellmetha>`_).
-* bugfix: BooleanField will now return `None` instead of generating an
-  error when xml is not present and False is not configured as `None`.
-  Contributed by Roman Voropaev
-  (`@roman-voropaev <https://github.com/roman-voropaev>`_).
-* Include xml namespace in base TEI class in eulxml.xmlmap.teimap
-  for xml:id attributes referenced throughout.
-
-
-0.22.1
-------
-
-* bugfix: workaround for resolver error failing to load schemas in some
-  cases
-
-0.22
-----
-
-* New method (:meth:`eulxml.xmlmap.load_xslt`) to load and precompile XSLT
-  that will be used more than once.
-* Re-worked :meth:`eulxml.xmlmap.XmlObject.xsl_transform` to avoid
-  malloc errors and segmentation faults and to allow using precompiled
-  XSLT documents.
-* Support for float field types in eulxml.xmlmap.  Contributed by
-  `jilott <https://github.com/jilott>`_.
-
-0.21.2
-------
-
-* Bug fix: correctly support parameters in
-  :meth:`eulxml.xmlmap.XmlObject.xsl_transform`
-* Automatically encode string parameter values passed to
-  :meth:`~eulxml.xmlmap.XmlObject.xsl_transform` as
-  lxml string parameters (:class:`lxml.etree.XSLT.strparam`)
-
-0.21.1
-------
-
-* Bug fix: :meth:`eulxml.xmlmap.XmlObject.xsl_transform` now recognizes
-  text output as a valid, non-empty XSL result
-
-0.21
-----
-
-* Add default unicode output of date value for MODS date fields
-  (:class:`~eulxml.xmlmap.mods.Date` and all date variants)
-* Bug fix: :class:`~eulxml.forms.XmlObjectForm` now uses the
-  field order as defined on the form when updating the XML instance
-  (fix for XML where schema requires fields in a specific order)
-
-
-0.20.3
-------
-
-* Revert unused namespace cleanup change to serialization it generates
-  less optimal output in certain cases.
-* Minor updates to :mod:`~eulxml.xmlmap.eadmap`:
-
-  * Added mapping for `xlink:show` attribute to
-    :class:`~eulxml.xmlmap.eadmap.DigitalArchivalObject`
-  * Added mapping for `note` field
-    :class:`~eulxml.xmlmap.eadmap.Index`
-  * Changed :class:`~eulxml.xmlmap.eadmap.Note` paragraph content from
-    string list to node list, to support formatting.
-  * Added mapping for ``processinfo`` to
-    :class:`~eulxml.xmlmap.eadmap.ArchivalDescription` and
-    :class:`~eulxml.xmlmap.eadmap.Component`
-
-0.20.2
--------
-
-* Unused namespaces will now be cleaned up before serialization in
-  :meth:`eulxml.xmlmap.XmlObject.serialize` and
-  :meth:`eulxml.xmlmap.XmlObject.serializeDocument`
-* :mod:`eulxml.xmlmap.eadmap` have been updated with root element names
-  where possible, to better support using :mod:`~eulxml.xmlmap.eadmap` to
-  update or modify EAD documents.
-
-0.20.1
--------
-
-* Adjust :mod:`eulxml.xmlmap` fields for better results when inspected by
-  sphinx autodoc or other similar tools.
-
-0.20.0
--------
-
-* Update :mod:`eulxml.xmlmap.mods` with support for id attribute on top-level MODS
-  element. Contributed by `bcail <https://github.com/bcail>`_.
-* Update :mod:`eulxml.xmlmap.eadmap` with support for digital archival object tags.
-* Add :class:`eulxml.xmlmap.fields.DateField` to support date fields
-  separately from :class:`eulxml.xmlmap.fields.DateTimeField`; also includes
-  minimal support for date fields in :class:`eulxml.forms.xmlobject.XmlObjectForm`.
-
-0.19.1
--------
-
-* Pinned MODS version to 3.4 to guard against new versions of the schema breaking validation
-
-0.19.0
--------
-
-* Corrected a minor bug where schema validation errors were not cleared between
-  multiple validations.
-* To avoid permission denied warning for auto-generated parser files,
-  parsetab files are now created in python tempdir if the running user
-  doesn't have write permission in the package installation directory.
-  [`Issue 1 <https://github.com/emory-libraries/eulxml/issues/1>`_]
-* When an XSLT transformation results in an empty document,
-  :meth:`eulxml.xmlap.XmlObject.xsl_transform` now returns None.
-  [`Issue 6 <https://github.com/emory-libraries/eulxml/issues/6>`_]
-* Development requirements can now be installed as an optional requirement
-  of the eulxml package (``pip install "eulxml[dev]"``).
-* Unit tests have been updated to use :mod:`nose`
-* New functionality in :mod:`eulxml.xmlmap.cerp` for parsing email dates
-  and generating CERP xml from a Python email message object.
-
-
-0.18.0 - Formset Ordering and DateTime
---------------------------------------
-
-* :class:`eulxml.forms.xmlobject.XmlObjectForm` formsets now support
-  ``can_order``.
-* :class:`eulxml.xmlmap.fields.DateTimeField` is now included in
-  available :mod:`eulxml.xmlmap` fields.  This replaces the previously
-  officially-unreleased, under-documented and -tested and misnamed
-  ``DateField``.  Date-time format handling and whitespace
-  normalization contributed by `jheath- <https://github.com/jheath->`_.
-
-
-0.17.1 - Bugfix Release
------------------------
-
-* Fixed an error in eulxml.xpath parse that resulted in parse errors
-  when other lexers are defined.
-
-
-0.17.0 - Minor Enhancements
----------------------------
-
-* :class:`eulxml.xmlmap.XmlObject` now supports lazy-loading for XSD
-  Schemas.  To take advantage of this feature,
-  :class:`~eulxml.xmlmap.XmlObject` subclasses should define an
-  ``XSD_SCHEMA`` location but should not set an ``xmlschema``.
-* When :ref:`field <xmlmap-field>` mapped on a
-  :class:`eulxml.xmlmap.XmlObject` is deleted, any XPath predicates
-  that could have been automatically constructed when setting the
-  value will be deleted from the :class:`~eulxml.xmlmap.XmlObject`
-  where possible, if they are otherwise empty.
-
-
-0.16.0 - MODS and PREMIS
-------------------------
-
-* Add basic support for `MODS <http://www.loc.gov/standards/mods/>`_ in
-  :mod:`eulxml.xmlmap.mods`.
-* Add basic support for `PREMIS <http://www.loc.gov/standards/premis/>`_ in
-  :mod:`eulxml.xmlmap.premis`.
-* Minor logging and error handling improvements.
-
-0.15.3 - Minor Enhancement
---------------------------
-
-* Downgrade the lack of an HTTP_PROXY set in the environment from a
-  RuntimeError to a Warning with schema validation disabled.
-
-0.15.2 - Bugfix Release
------------------------
-
-* Fixed an error in the dependency structure that prevented the package from
-  being used after installation through PyPI.
-
-0.15.1 - Bugfix Release
------------------------
-
-* Fixed an error in the dependency structure that prevented the package from
-  being installed through PyPI.
-
-0.15.0 - Initial Release
-------------------------
-
-* Split out xml-related components (:mod:`~eulxml.xpath`,
-  :mod:`~eulxml.xmlmap`, and :mod:`~eulxml.forms`) from :mod:`eulcore`
-  into :mod:`eulxml` for easier re-use.
+* Fork `eulxml <https://github.com/emory-libraries/eulxml>`_
+  package from version `1.1.3` with the new name `neuxml`
+* Remove `forms` submodule and drop Django requirements
+* Add GitHub workflow for pypi publication
+* Update for Python 3.12 compatibility