Skip to content

Commit

Permalink
Release py3.11 constraint, updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
atomprobe-tc committed Nov 27, 2023
1 parent a96332e commit 752a3fc
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 19 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@ Foster exchange about data models and work towards specifications
of file formats from the research field of atom probe microscopy.

# Getting started
You should create a virtual environment. We tested on Ubuntu with Python 3.8.
Newer versions of Python should work similarly when using the desired version tag.
You should create a virtual environment. We tested on Ubuntu with Python 3.8 and newer version.
In what follows the version (tag) 3.8 is a placeholder whereby we show how to proceed when using
Python 3.8. Using newer versions of Python should work the same by replacing 3.8 with the respective
version (tag).

If you don't have Python 3.8 installed on your computer, follow these commands:
Older versions of Python like 3.8 and 3.9 are available e.g. via the deadsnakes repository or via
conda. For using deadsnakes proceed with the following commands:
```
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt install python3.8 python3-dev libpython3.8-dev python3.8-venv
Expand Down
15 changes: 3 additions & 12 deletions dev-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#
# This file is autogenerated by pip-compile with Python 3.9
# This file is autogenerated by pip-compile with Python 3.11
# by the following command:
#
# pip-compile --extra=dev --output-file=dev-requirements.txt --resolver=backtracking pyproject.toml
# pip-compile --extra=dev --output-file=dev-requirements.txt pyproject.toml
#
anyio==3.6.2
# via jupyter-server
Expand Down Expand Up @@ -72,13 +72,8 @@ idna==3.4
# requests
importlib-metadata==6.6.0
# via
# jupyter-client
# jupyterlab-server
# keyring
# nbconvert
# twine
importlib-resources==5.12.0
# via matplotlib
ipykernel==6.22.0
# via
# nbclassic
Expand Down Expand Up @@ -355,8 +350,6 @@ traitlets==5.9.0
# notebook
twine==4.0.2
# via ifes-apt-tc-data-modeling (pyproject.toml)
typing-extensions==4.5.0
# via ipython
tzdata==2023.3
# via pandas
urllib3==1.26.15
Expand All @@ -372,9 +365,7 @@ webencodings==0.5.1
websocket-client==1.5.1
# via jupyter-server
zipp==3.15.0
# via
# importlib-metadata
# importlib-resources
# via importlib-metadata

# The following packages are considered to be unsafe in a requirements file:
# setuptools
10 changes: 6 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ authors = [
description = "Foster exchange about data models and work towards clear specifications of file formats and data models in the research field of atom probe microscopy."
readme = "README.md"
license = { file = "LICENSE.txt" }
requires-python = ">=3.8,<3.11"
requires-python = ">=3.8"
classifiers = [
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
]
Expand All @@ -29,9 +31,9 @@ dependencies = [

[project.optional-dependencies]
dev = [
"twine>=4.0.2",
"jupyterlab_h5web>=6.6.1",
"jupyterlab>=3.5.2,<3.6.0"
"twine",
"jupyterlab_h5web",
"jupyterlab"
]

# [tool.setuptools]
Expand Down

0 comments on commit 752a3fc

Please sign in to comment.