add python3.12; build tools updates (#60)

* add py312

* remove black; use ruff format

* add an rc version

* convert docs to markdown

* quote urls?

* update changelog

* release 0.9.0

.github/workflows/main.yml

@@ -11,7 +11,7 @@ jobs:
  strategy:
  max-parallel: 4
  matrix:
- python-version: ["3.8", "3.9", "3.10", "3.11", "3.12-dev"]
+ python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
  steps:
  - uses: actions/checkout@v3

HISTORY.rst → HISTORY.md

@@ -1,13 +1,17 @@
-History
-=======
+# History
 
-v0.8.1 (2023-07-17)
--------------------
+## v0.9.0 (2024-01-17)
+
+* Improve performance to yield from file objects instead of loading into memory at once (@scott-8 #57)
+* Support Python 3.12
+* (dev) Remove black; use ruff format instead
+* (dev) Rewrite restructured text docs to markdown
+
+## v0.8.1 (2023-07-17)
 
 * Update RIS exporter to optionally write list tags or delimited single tags (@scott-8 #55)
 
-v0.8.0 (2023-07-13)
--------------------
+## v0.8.0 (2023-07-13)
 
 Breaking changes:
 
@@ -27,13 +31,11 @@ Tooling updates:
 * Switch to flit
 * Add basic coverage reports to github actions
 
-v0.7.1 (2021-06-01)
--------------------
+## v0.7.1 (2021-06-01)
 
 * README.rst formatting fixes
 
-v0.7.0 (2021-06-01)
--------------------
+## v0.7.0 (2021-06-01)
 
 New features:
 
@@ -45,25 +47,22 @@ New features:
 * Support python versions 3.6, 3.7, 3.8, and 3.9 (@shapiromatron #44)
 * Changed primary branch from `master` to `main`
 
-v0.6.0 (2020-11-04)
--------------------
+## v0.6.0 (2020-11-04)
 
 New features:
 
 * Add new optional `strict=True` parameter to rispy.load/loads to allow parsing of RIS files with comments or additional metadata which aren't allowed/forbidden in spec (@ShreyRavi)
 * Allow pathlib.Path objects in rispy.load in addition to file objects
 * Enable multiple python environments in github test matrix (python 3.6, 3.7, and 3.8)
 
-v0.5.1 (2020-09-29)
--------------------
+## v0.5.1 (2020-09-29)
 
 New features:
 
 * Strip BOM before processing records
 * Accept ER tag without trailing whitespace
 
-v0.5 (2020-02-21)
------------------
+## v0.5 (2020-02-21)
 
 New features:
 
@@ -77,21 +76,18 @@ Breaking changes:
 
 * Rename package from `RISparser` to `rispy`
 * Revise API for reading RIS files to mirror python APIs (like `json`, `pickle`)
-* `SE` RIS key mapped to `section` instead of `version` (per wikipedia_)
+* `SE` RIS key mapped to `section` instead of `version` (per [wikipedia](https://en.wikipedia.org/wiki/RIS_(file_format)))
 * `NV` RIS key mapped to `number_of_volumes` instead of `number_of_Volumes`
 * `N2` RIS key mapped to `notes_abstract` instead of `abstract`
 * Python ≥ 3.6 required
 
-.. _wikipedia: https://en.wikipedia.org/wiki/RIS_(file_format)
+## v0.4.3 (2018-04-10)
 
-v0.4.3 (2018-04-10)
--------------------
 * Allow for blank lines at beginning of input file [fixes #3]
 
+## v0.4.2 (2017-05-29)
 
-v0.4.2 (2017-05-29)
--------------------
-* parser saves unknown tags into an ``unknown_tag`` key in dict
+* parser saves unknown tags into an `unknown_tag` key in dict
 * python2/3 compatible
 * Notes (N1) is now a ListType
 * Documented testing with pytest

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 rispy authors
+Copyright (c) 2024 rispy authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -34,10 +34,10 @@ clean: ## Remove all build, test and Python artifacts
  find . -name '__pycache__' -exec rm -fr {} +
 
 lint: ## Check python formatting issues
- @black . --check && ruff .
+ @ruff format . --check && ruff .
 
 format: ## Fix python formatting issues where possible
- @black . && ruff . --fix --show-fixes
+ @ruff format . && ruff . --fix --show-fixes
 
 test: ## Run unit test suite
  @py.test