amulet-core 2.0.1a0__tar.gz → 2.0.1a2__tar.gz

{amulet_core-2.0.1a0 → amulet_core-2.0.1a2}/CMakeLists.txt

@@ -1,111 +1,111 @@
-cmake_minimum_required(VERSION 3.13)
-
-project(amulet_core LANGUAGES CXX)
-
-# Set C++20
-set(CMAKE_CXX_STANDARD 20)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
-set(CMAKE_CXX_EXTENSIONS OFF)
-
-# Set platform variables
-if (WIN32)
-	# set windows 7 as the minimum version
-	add_definitions(-D_WIN32_WINNT=0x0601)
-elseif(APPLE)
-    set(CMAKE_OSX_DEPLOYMENT_TARGET "10.15")
-else()
-    set(CMAKE_POSITION_INDEPENDENT_CODE ON)
-endif()
-
-if (MSVC)
-    add_definitions("/MP")
-endif()
-
-include(FetchContent)
-
-# Add zlib
-set(ZLIB_BUILD_EXAMPLES OFF)
-FetchContent_Declare(
-  zlib
-  GIT_REPOSITORY https://github.com/madler/zlib.git
-  GIT_TAG        51b7f2abdade71cd9bb0e7a373ef2610ec6f9daf
-)
-FetchContent_MakeAvailable(zlib)
-set(ZLIB_ROOT ${zlib_SOURCE_DIR})
-set(ZLIB_USE_STATIC_LIBS ON)
-set(ZLIB_LIBRARY ${INSTALL_LIB_DIR})
-find_package(ZLIB REQUIRED)
-target_compile_definitions(zlibstatic PUBLIC ZLIB_CONST)
-
-# Add lz4
-FetchContent_Declare(
-  lz4
-  GIT_REPOSITORY https://github.com/lz4/lz4.git
-  GIT_TAG        ebb370ca83af193212df4dcbadcc5d87bc0de2f0
-)
-FetchContent_MakeAvailable(lz4)
-set(LZ4_BUILD_CLI OFF)
-add_subdirectory(${lz4_SOURCE_DIR}/build/cmake)
-
-# Add pybind11
-find_package(pybind11 CONFIG REQUIRED)
-
-# Add Amulet libraries
-find_package(amulet_pybind11_extensions CONFIG REQUIRED)
-find_package(amulet_io CONFIG REQUIRED)
-find_package(amulet_nbt CONFIG REQUIRED)
-
-# Find C++ files
-file(REAL_PATH src SOURCE_PATH)
-file(GLOB_RECURSE EXTENSION_SOURCES LIST_DIRECTORIES false ${SOURCE_PATH}/amulet/*.py.cpp)
-file(GLOB_RECURSE EXTENSION_HEADERS LIST_DIRECTORIES false ${SOURCE_PATH}/amulet/*.py.hpp)
-file(GLOB_RECURSE SOURCES LIST_DIRECTORIES false ${SOURCE_PATH}/amulet/*.cpp)
-file(GLOB_RECURSE HEADERS LIST_DIRECTORIES false ${SOURCE_PATH}/amulet/*.hpp)
-list(REMOVE_ITEM SOURCES ${EXTENSION_SOURCES})
-list(REMOVE_ITEM HEADERS ${EXTENSION_HEADERS})
-
-# Add implementation
-add_library(amulet_core SHARED)
-target_link_libraries( amulet_core PRIVATE zlibstatic )
-target_link_libraries( amulet_core PRIVATE lz4_static )
-target_link_libraries( amulet_core PRIVATE amulet_io )
-target_link_libraries( amulet_core PRIVATE amulet_nbt )
-target_compile_definitions(amulet_core PRIVATE ExportAmuletCore)
-target_include_directories(amulet_core PUBLIC ${SOURCE_PATH})
-target_sources(amulet_core PRIVATE ${SOURCES} ${HEADERS})
-foreach(FILE ${SOURCES} ${HEADERS})
-    file(RELATIVE_PATH REL_PATH ${SOURCE_PATH} ${FILE})
-    get_filename_component(GROUP ${REL_PATH} DIRECTORY)
-    string(REPLACE "/" "\\" GROUP ${GROUP})
-    source_group(${GROUP} FILES ${FILE})
-endforeach()
-
-# Add python extension
-pybind11_add_module(_amulet_core)
-target_link_libraries( _amulet_core PRIVATE amulet_pybind11_extensions )
-target_link_libraries( _amulet_core PRIVATE amulet_io )
-target_link_libraries( _amulet_core PRIVATE amulet_nbt )
-target_link_libraries( _amulet_core PRIVATE amulet_core )
-target_compile_definitions(_amulet_core PRIVATE PYBIND11_DETAILED_ERROR_MESSAGES)
-target_compile_definitions(_amulet_core PRIVATE PYBIND11_VERSION="${pybind11_VERSION}")
-target_compile_definitions(_amulet_core PRIVATE COMPILER_ID="${CMAKE_CXX_COMPILER_ID}")
-target_compile_definitions(_amulet_core PRIVATE COMPILER_VERSION="${CMAKE_CXX_COMPILER_VERSION}")
-target_sources(_amulet_core PRIVATE ${EXTENSION_SOURCES} ${EXTENSION_HEADERS})
-foreach(FILE ${EXTENSION_SOURCES} ${EXTENSION_HEADERS})
-    file(RELATIVE_PATH REL_PATH ${SOURCE_PATH} ${FILE})
-    get_filename_component(GROUP ${REL_PATH} DIRECTORY)
-    string(REPLACE "/" "\\" GROUP ${GROUP})
-    source_group(${GROUP} FILES ${FILE})
-endforeach()
-
-if(NOT DEFINED AMULET_CORE_EXT_DIR)
-    set(AMULET_CORE_EXT_DIR ${amulet_core_DIR})
-endif()
-
-# Install
-install(TARGETS amulet_core DESTINATION ${amulet_core_DIR})
-install(TARGETS _amulet_core DESTINATION ${AMULET_CORE_EXT_DIR})
-
-if (DEFINED BUILD_AMULET_CORE_TESTS)
-    add_subdirectory(tests)
-endif()
+cmake_minimum_required(VERSION 3.13)
+
+project(amulet_core LANGUAGES CXX)
+
+# Set C++20
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+# Set platform variables
+if (WIN32)
+	# set windows 7 as the minimum version
+	add_definitions(-D_WIN32_WINNT=0x0601)
+elseif(APPLE)
+    set(CMAKE_OSX_DEPLOYMENT_TARGET "10.15")
+else()
+    set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+endif()
+
+if (MSVC)
+    add_definitions("/MP")
+endif()
+
+include(FetchContent)
+
+# Add zlib
+set(ZLIB_BUILD_EXAMPLES OFF)
+FetchContent_Declare(
+  zlib
+  GIT_REPOSITORY https://github.com/madler/zlib.git
+  GIT_TAG        51b7f2abdade71cd9bb0e7a373ef2610ec6f9daf
+)
+FetchContent_MakeAvailable(zlib)
+set(ZLIB_ROOT ${zlib_SOURCE_DIR})
+set(ZLIB_USE_STATIC_LIBS ON)
+set(ZLIB_LIBRARY ${INSTALL_LIB_DIR})
+find_package(ZLIB REQUIRED)
+target_compile_definitions(zlibstatic PUBLIC ZLIB_CONST)
+
+# Add lz4
+FetchContent_Declare(
+  lz4
+  GIT_REPOSITORY https://github.com/lz4/lz4.git
+  GIT_TAG        ebb370ca83af193212df4dcbadcc5d87bc0de2f0
+)
+FetchContent_MakeAvailable(lz4)
+set(LZ4_BUILD_CLI OFF)
+add_subdirectory(${lz4_SOURCE_DIR}/build/cmake)
+
+# Add pybind11
+find_package(pybind11 CONFIG REQUIRED)
+
+# Add Amulet libraries
+find_package(amulet_pybind11_extensions CONFIG REQUIRED)
+find_package(amulet_io CONFIG REQUIRED)
+find_package(amulet_nbt CONFIG REQUIRED)
+
+# Find C++ files
+file(REAL_PATH src SOURCE_PATH)
+file(GLOB_RECURSE EXTENSION_SOURCES LIST_DIRECTORIES false ${SOURCE_PATH}/amulet/*.py.cpp)
+file(GLOB_RECURSE EXTENSION_HEADERS LIST_DIRECTORIES false ${SOURCE_PATH}/amulet/*.py.hpp)
+file(GLOB_RECURSE SOURCES LIST_DIRECTORIES false ${SOURCE_PATH}/amulet/*.cpp)
+file(GLOB_RECURSE HEADERS LIST_DIRECTORIES false ${SOURCE_PATH}/amulet/*.hpp)
+list(REMOVE_ITEM SOURCES ${EXTENSION_SOURCES})
+list(REMOVE_ITEM HEADERS ${EXTENSION_HEADERS})
+
+# Add implementation
+add_library(amulet_core SHARED)
+target_link_libraries( amulet_core PRIVATE zlibstatic )
+target_link_libraries( amulet_core PRIVATE lz4_static )
+target_link_libraries( amulet_core PRIVATE amulet_io )
+target_link_libraries( amulet_core PRIVATE amulet_nbt )
+target_compile_definitions(amulet_core PRIVATE ExportAmuletCore)
+target_include_directories(amulet_core PUBLIC ${SOURCE_PATH})
+target_sources(amulet_core PRIVATE ${SOURCES} ${HEADERS})
+foreach(FILE ${SOURCES} ${HEADERS})
+    file(RELATIVE_PATH REL_PATH ${SOURCE_PATH} ${FILE})
+    get_filename_component(GROUP ${REL_PATH} DIRECTORY)
+    string(REPLACE "/" "\\" GROUP ${GROUP})
+    source_group(${GROUP} FILES ${FILE})
+endforeach()
+
+# Add python extension
+pybind11_add_module(_amulet_core)
+target_link_libraries( _amulet_core PRIVATE amulet_pybind11_extensions )
+target_link_libraries( _amulet_core PRIVATE amulet_io )
+target_link_libraries( _amulet_core PRIVATE amulet_nbt )
+target_link_libraries( _amulet_core PRIVATE amulet_core )
+target_compile_definitions(_amulet_core PRIVATE PYBIND11_DETAILED_ERROR_MESSAGES)
+target_compile_definitions(_amulet_core PRIVATE PYBIND11_VERSION="${pybind11_VERSION}")
+target_compile_definitions(_amulet_core PRIVATE COMPILER_ID="${CMAKE_CXX_COMPILER_ID}")
+target_compile_definitions(_amulet_core PRIVATE COMPILER_VERSION="${CMAKE_CXX_COMPILER_VERSION}")
+target_sources(_amulet_core PRIVATE ${EXTENSION_SOURCES} ${EXTENSION_HEADERS})
+foreach(FILE ${EXTENSION_SOURCES} ${EXTENSION_HEADERS})
+    file(RELATIVE_PATH REL_PATH ${SOURCE_PATH} ${FILE})
+    get_filename_component(GROUP ${REL_PATH} DIRECTORY)
+    string(REPLACE "/" "\\" GROUP ${GROUP})
+    source_group(${GROUP} FILES ${FILE})
+endforeach()
+
+if(NOT DEFINED AMULET_CORE_EXT_DIR)
+    set(AMULET_CORE_EXT_DIR ${amulet_core_DIR})
+endif()
+
+# Install
+install(TARGETS amulet_core DESTINATION ${amulet_core_DIR})
+install(TARGETS _amulet_core DESTINATION ${AMULET_CORE_EXT_DIR})
+
+if (DEFINED BUILD_AMULET_CORE_TESTS)
+    add_subdirectory(tests)
+endif()

{amulet_core-2.0.1a0 → amulet_core-2.0.1a2}/MANIFEST.in

@@ -1,8 +1,8 @@
-include build_requires.py
-include requirements.py
-
-recursive-include src/amulet *.cpp *.hpp *Config.cmake
-
-include CMakeLists.txt
-
-prune tests
+include build_requires.py
+include requirements.py
+
+recursive-include src/amulet *.cpp *.hpp *Config.cmake
+
+include CMakeLists.txt
+
+prune tests

{amulet_core-2.0.1a0/src/amulet_core.egg-info → amulet_core-2.0.1a2}/PKG-INFO

@@ -1,108 +1,108 @@
-Metadata-Version: 2.4
-Name: amulet-core
-Version: 2.0.1a0
-Summary: A Python library for reading/writing Minecraft's various save formats.
-Author: James Clare, Ben Gothard
-Project-URL: Homepage, https://www.amuletmc.com
-Project-URL: Repository, https://github.com/Amulet-Team/Amulet-Core
-Project-URL: Issues, https://github.com/Amulet-Team/Amulet-Core/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: amulet-compiler-target==1.0
-Requires-Dist: numpy~=2.0
-Requires-Dist: amulet-compiler-version==3.0.0
-Requires-Dist: amulet-io~=1.0
-Requires-Dist: amulet-nbt~=4.0.0.0a24
-Provides-Extra: docs
-Requires-Dist: Sphinx>=1.7.4; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints>=1.3.0; extra == "docs"
-Requires-Dist: sphinx_rtd_theme>=0.3.1; extra == "docs"
-Provides-Extra: dev
-Requires-Dist: setuptools>=42; extra == "dev"
-Requires-Dist: versioneer; extra == "dev"
-Requires-Dist: packaging; extra == "dev"
-Requires-Dist: wheel; extra == "dev"
-Requires-Dist: pybind11[global]==2.13.6; extra == "dev"
-Requires-Dist: amulet_pybind11_extensions~=1.0; extra == "dev"
-Requires-Dist: pybind11_stubgen>=2.5.4; extra == "dev"
-Requires-Dist: black>=22.3; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: autoflake; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: types-pyinstaller; extra == "dev"
-Requires-Dist: amulet-test-utils~=1.1; extra == "dev"
-Dynamic: requires-dist
-
-# Amulet Core
-
-![Build](../../workflows/Build/badge.svg)
-![Unittests](../../workflows/Unittests/badge.svg?event=push)
-![Stylecheck](../../workflows/Stylecheck/badge.svg?event=push)
-[![Documentation](https://readthedocs.org/projects/amulet-core/badge)](https://amulet-core.readthedocs.io)
-
-A Python 3 library to read and write data from Minecraft's various save formats.
-
-This library provides the main world editing functionality for Amulet Map Editor
-
-#### If you are looking for the actual editor it can be found at [Amulet Map Editor](https://github.com/Amulet-Team/Amulet-Map-Editor)
-
-
-## Documentation
-
-Our online documentation can be found here: https://amulet-core.readthedocs.io
-
-## Installing
-1) Install Python 3.7
-2) We recommend setting up a [python virtual environment](https://docs.python.org/3/tutorial/venv.html) so you don't run into issues with dependency conflicts.
-3) run `pip install amulet-core` to install the library and all its dependencies.
-
-## Dependencies
-
-This library uses a number of other libraries. These will be automatically installed when running the command above.
-- Numpy
-- [Amulet_NBT](https://github.com/Amulet-Team/Amulet-NBT)
-- [PyMCTranslate](https://github.com/gentlegiantJGC/PyMCTranslate)
-
-## Contributing
-
-### For Development
-Download the code to your computer, install python and run the following command from the root directory.
-run `pip install -e .[dev]`
-This command will install the library in development mode with the libraries required for development.
-- [Black](https://github.com/ambv/black) (Required for formatting)
-  - Must be run before pushing a Pull Request
-
-For information about contributing to this project, please see the contribution section [below](#contributing)
-
-### Code Formatting
-For code formatting, we use the formatting utility [black](https://github.com/psf/black). 
-To run it, run the following command from your favorite terminal after installing: `black amulet tests`
-
-In order for your pull request to be accepted, this command must be run to format every file.
-
-### Building the Documentation
-To build the documentation locally, run the following command: `make html` and then navigate to the
-generated directory `docs_build/html` in your favorite web browser
-
-### Branch Naming
-Branches should be created when a certain bug or feature may take multiple attempts to fix. Naming
-them should follow the following convention (even for forked repositories when a pull request is being made):
-
-* For features, use: `impl-<feature name>`
-* For bug fixes, use: `bug-<bug tracker ID>`
-* For improvements/rewrites, use: `improv-<feature name>`
-* For prototyping, use: `proto-<feature name>`
-
-### Pull Requests
-We ask that submitted Pull Requests give moderately detailed notes about the changes and explain 
-any changes that were made to the program outside of those directly related to the feature/bug-fix.
-Make sure to run all tests and formatting otherwise we cannot accept your pull request.
-
-_Note: We will also re-run all tests before reviewing, this is to mitigate additional changes/commits
-needed to pass all tests._
-
-Once a Pull Request is submitted, we will mark the request for review, once that is done, we will
-review the changes and provide any notes/things to change. Once all additional changes have been made,
-we will merge the request.
+Metadata-Version: 2.4
+Name: amulet-core
+Version: 2.0.1a2
+Summary: A Python library for reading/writing Minecraft's various save formats.
+Author: James Clare, Ben Gothard
+Project-URL: Homepage, https://www.amuletmc.com
+Project-URL: Repository, https://github.com/Amulet-Team/Amulet-Core
+Project-URL: Issues, https://github.com/Amulet-Team/Amulet-Core/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: amulet-compiler-target==1.0
+Requires-Dist: numpy~=2.0
+Requires-Dist: amulet-compiler-version==3.0.0
+Requires-Dist: amulet-io~=1.0
+Requires-Dist: amulet-nbt~=4.0.1.0a2
+Provides-Extra: docs
+Requires-Dist: Sphinx>=1.7.4; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=1.3.0; extra == "docs"
+Requires-Dist: sphinx_rtd_theme>=0.3.1; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: setuptools>=42; extra == "dev"
+Requires-Dist: versioneer; extra == "dev"
+Requires-Dist: packaging; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: pybind11[global]==2.13.6; extra == "dev"
+Requires-Dist: amulet_pybind11_extensions~=1.0; extra == "dev"
+Requires-Dist: pybind11_stubgen>=2.5.4; extra == "dev"
+Requires-Dist: black>=22.3; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: autoflake; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-pyinstaller; extra == "dev"
+Requires-Dist: amulet-test-utils~=1.1; extra == "dev"
+Dynamic: requires-dist
+
+# Amulet Core
+
+![Build](../../workflows/Build/badge.svg)
+![Unittests](../../workflows/Unittests/badge.svg?event=push)
+![Stylecheck](../../workflows/Stylecheck/badge.svg?event=push)
+[![Documentation](https://readthedocs.org/projects/amulet-core/badge)](https://amulet-core.readthedocs.io)
+
+A Python 3 library to read and write data from Minecraft's various save formats.
+
+This library provides the main world editing functionality for Amulet Map Editor
+
+#### If you are looking for the actual editor it can be found at [Amulet Map Editor](https://github.com/Amulet-Team/Amulet-Map-Editor)
+
+
+## Documentation
+
+Our online documentation can be found here: https://amulet-core.readthedocs.io
+
+## Installing
+1) Install Python 3.7
+2) We recommend setting up a [python virtual environment](https://docs.python.org/3/tutorial/venv.html) so you don't run into issues with dependency conflicts.
+3) run `pip install amulet-core` to install the library and all its dependencies.
+
+## Dependencies
+
+This library uses a number of other libraries. These will be automatically installed when running the command above.
+- Numpy
+- [Amulet_NBT](https://github.com/Amulet-Team/Amulet-NBT)
+- [PyMCTranslate](https://github.com/gentlegiantJGC/PyMCTranslate)
+
+## Contributing
+
+### For Development
+Download the code to your computer, install python and run the following command from the root directory.
+run `pip install -e .[dev]`
+This command will install the library in development mode with the libraries required for development.
+- [Black](https://github.com/ambv/black) (Required for formatting)
+  - Must be run before pushing a Pull Request
+
+For information about contributing to this project, please see the contribution section [below](#contributing)
+
+### Code Formatting
+For code formatting, we use the formatting utility [black](https://github.com/psf/black). 
+To run it, run the following command from your favorite terminal after installing: `black amulet tests`
+
+In order for your pull request to be accepted, this command must be run to format every file.
+
+### Building the Documentation
+To build the documentation locally, run the following command: `make html` and then navigate to the
+generated directory `docs_build/html` in your favorite web browser
+
+### Branch Naming
+Branches should be created when a certain bug or feature may take multiple attempts to fix. Naming
+them should follow the following convention (even for forked repositories when a pull request is being made):
+
+* For features, use: `impl-<feature name>`
+* For bug fixes, use: `bug-<bug tracker ID>`
+* For improvements/rewrites, use: `improv-<feature name>`
+* For prototyping, use: `proto-<feature name>`
+
+### Pull Requests
+We ask that submitted Pull Requests give moderately detailed notes about the changes and explain 
+any changes that were made to the program outside of those directly related to the feature/bug-fix.
+Make sure to run all tests and formatting otherwise we cannot accept your pull request.
+
+_Note: We will also re-run all tests before reviewing, this is to mitigate additional changes/commits
+needed to pass all tests._
+
+Once a Pull Request is submitted, we will mark the request for review, once that is done, we will
+review the changes and provide any notes/things to change. Once all additional changes have been made,
+we will merge the request.

{amulet_core-2.0.1a0 → amulet_core-2.0.1a2}/README.md

@@ -1,71 +1,71 @@
-# Amulet Core
-
-![Build](../../workflows/Build/badge.svg)
-![Unittests](../../workflows/Unittests/badge.svg?event=push)
-![Stylecheck](../../workflows/Stylecheck/badge.svg?event=push)
-[![Documentation](https://readthedocs.org/projects/amulet-core/badge)](https://amulet-core.readthedocs.io)
-
-A Python 3 library to read and write data from Minecraft's various save formats.
-
-This library provides the main world editing functionality for Amulet Map Editor
-
-#### If you are looking for the actual editor it can be found at [Amulet Map Editor](https://github.com/Amulet-Team/Amulet-Map-Editor)
-
-
-## Documentation
-
-Our online documentation can be found here: https://amulet-core.readthedocs.io
-
-## Installing
-1) Install Python 3.7
-2) We recommend setting up a [python virtual environment](https://docs.python.org/3/tutorial/venv.html) so you don't run into issues with dependency conflicts.
-3) run `pip install amulet-core` to install the library and all its dependencies.
-
-## Dependencies
-
-This library uses a number of other libraries. These will be automatically installed when running the command above.
-- Numpy
-- [Amulet_NBT](https://github.com/Amulet-Team/Amulet-NBT)
-- [PyMCTranslate](https://github.com/gentlegiantJGC/PyMCTranslate)
-
-## Contributing
-
-### For Development
-Download the code to your computer, install python and run the following command from the root directory.
-run `pip install -e .[dev]`
-This command will install the library in development mode with the libraries required for development.
-- [Black](https://github.com/ambv/black) (Required for formatting)
-  - Must be run before pushing a Pull Request
-
-For information about contributing to this project, please see the contribution section [below](#contributing)
-
-### Code Formatting
-For code formatting, we use the formatting utility [black](https://github.com/psf/black). 
-To run it, run the following command from your favorite terminal after installing: `black amulet tests`
-
-In order for your pull request to be accepted, this command must be run to format every file.
-
-### Building the Documentation
-To build the documentation locally, run the following command: `make html` and then navigate to the
-generated directory `docs_build/html` in your favorite web browser
-
-### Branch Naming
-Branches should be created when a certain bug or feature may take multiple attempts to fix. Naming
-them should follow the following convention (even for forked repositories when a pull request is being made):
-
-* For features, use: `impl-<feature name>`
-* For bug fixes, use: `bug-<bug tracker ID>`
-* For improvements/rewrites, use: `improv-<feature name>`
-* For prototyping, use: `proto-<feature name>`
-
-### Pull Requests
-We ask that submitted Pull Requests give moderately detailed notes about the changes and explain 
-any changes that were made to the program outside of those directly related to the feature/bug-fix.
-Make sure to run all tests and formatting otherwise we cannot accept your pull request.
-
-_Note: We will also re-run all tests before reviewing, this is to mitigate additional changes/commits
-needed to pass all tests._
-
-Once a Pull Request is submitted, we will mark the request for review, once that is done, we will
-review the changes and provide any notes/things to change. Once all additional changes have been made,
-we will merge the request.
+# Amulet Core
+
+![Build](../../workflows/Build/badge.svg)
+![Unittests](../../workflows/Unittests/badge.svg?event=push)
+![Stylecheck](../../workflows/Stylecheck/badge.svg?event=push)
+[![Documentation](https://readthedocs.org/projects/amulet-core/badge)](https://amulet-core.readthedocs.io)
+
+A Python 3 library to read and write data from Minecraft's various save formats.
+
+This library provides the main world editing functionality for Amulet Map Editor
+
+#### If you are looking for the actual editor it can be found at [Amulet Map Editor](https://github.com/Amulet-Team/Amulet-Map-Editor)
+
+
+## Documentation
+
+Our online documentation can be found here: https://amulet-core.readthedocs.io
+
+## Installing
+1) Install Python 3.7
+2) We recommend setting up a [python virtual environment](https://docs.python.org/3/tutorial/venv.html) so you don't run into issues with dependency conflicts.
+3) run `pip install amulet-core` to install the library and all its dependencies.
+
+## Dependencies
+
+This library uses a number of other libraries. These will be automatically installed when running the command above.
+- Numpy
+- [Amulet_NBT](https://github.com/Amulet-Team/Amulet-NBT)
+- [PyMCTranslate](https://github.com/gentlegiantJGC/PyMCTranslate)
+
+## Contributing
+
+### For Development
+Download the code to your computer, install python and run the following command from the root directory.
+run `pip install -e .[dev]`
+This command will install the library in development mode with the libraries required for development.
+- [Black](https://github.com/ambv/black) (Required for formatting)
+  - Must be run before pushing a Pull Request
+
+For information about contributing to this project, please see the contribution section [below](#contributing)
+
+### Code Formatting
+For code formatting, we use the formatting utility [black](https://github.com/psf/black). 
+To run it, run the following command from your favorite terminal after installing: `black amulet tests`
+
+In order for your pull request to be accepted, this command must be run to format every file.
+
+### Building the Documentation
+To build the documentation locally, run the following command: `make html` and then navigate to the
+generated directory `docs_build/html` in your favorite web browser
+
+### Branch Naming
+Branches should be created when a certain bug or feature may take multiple attempts to fix. Naming
+them should follow the following convention (even for forked repositories when a pull request is being made):
+
+* For features, use: `impl-<feature name>`
+* For bug fixes, use: `bug-<bug tracker ID>`
+* For improvements/rewrites, use: `improv-<feature name>`
+* For prototyping, use: `proto-<feature name>`
+
+### Pull Requests
+We ask that submitted Pull Requests give moderately detailed notes about the changes and explain 
+any changes that were made to the program outside of those directly related to the feature/bug-fix.
+Make sure to run all tests and formatting otherwise we cannot accept your pull request.
+
+_Note: We will also re-run all tests before reviewing, this is to mitigate additional changes/commits
+needed to pass all tests._
+
+Once a Pull Request is submitted, we will mark the request for review, once that is done, we will
+review the changes and provide any notes/things to change. Once all additional changes have been made,
+we will merge the request.

{amulet_core-2.0.1a0 → amulet_core-2.0.1a2}/build_requires.py

@@ -1,24 +1,24 @@
-from typing import Union, Mapping
-import requirements
-
-from setuptools import build_meta
-from setuptools.build_meta import *
-
-
-def get_requires_for_build_wheel(
-    config_settings: Union[Mapping[str, Union[str, list[str], None]], None] = None,
-) -> list[str]:
-    return [
-        *build_meta.get_requires_for_build_wheel(config_settings),
-        "wheel",
-        *requirements.get_build_dependencies(),
-    ]
-
-
-def get_requires_for_build_editable(
-    config_settings: Union[Mapping[str, Union[str, list[str], None]], None] = None,
-) -> list[str]:
-    return [
-        *build_meta.get_requires_for_build_editable(config_settings),
-        *requirements.get_build_dependencies(),
-    ]
+from typing import Union, Mapping
+import requirements
+
+from setuptools import build_meta
+from setuptools.build_meta import *
+
+
+def get_requires_for_build_wheel(
+    config_settings: Union[Mapping[str, Union[str, list[str], None]], None] = None,
+) -> list[str]:
+    return [
+        *build_meta.get_requires_for_build_wheel(config_settings),
+        "wheel",
+        *requirements.get_build_dependencies(),
+    ]
+
+
+def get_requires_for_build_editable(
+    config_settings: Union[Mapping[str, Union[str, list[str], None]], None] = None,
+) -> list[str]:
+    return [
+        *build_meta.get_requires_for_build_editable(config_settings),
+        *requirements.get_build_dependencies(),
+    ]