arches-he-sysref-funcs

A small Arches extension app providing additional system reference functions for Arches-based projects. Designed for easy integration with Arches projects (Historic England context).

Requirements

• Python 3.10+ (Check the Arches python requirements and match your Python version))
• Arches 7.6

Some elements of this app are designed to work with Historic England's specific data model and may not be suitable for other projects without modification.

Installing for Development

For development purposes, you can treat this app as a standard Arches project. Either use the instructions for developing an Arches project or use the arches-containers configuration included in this repository.

• For development (standard):

  pip install -e '/path/to/arches_he_sysref_funcs[dev]'
  

  This installs the app in editable mode, allowing you to make changes and see them reflected immediately without needing to reinstall.

• For development using included arches-container configuration:

  Please ensure that you clone the arches-he-sysref-funcs repository into a directory that uses underscores instead of hyphens, as the arches-containers configuration expects this format. For example, clone it to arches_he_sysref_funcs.

  git clone https://github.com/HistoricEngland/arches-he-sysref-funcs.git arches_he_sysref_funcs
  

  This repository includes an arches-containers project configuration, so you can import, activate, and start the system as follows:

  1. Ensure Docker is installed and running.

  2. Navigate to your workspace directory (the root where your projects and containers live).

  3. Import the arches-container project configuration:

     act import -p arches_he_sysref_funcs
     

  4. Activate the project:

     act activate -p arches_he_sysref_funcs
     

  5. Start the system:

     act up
     

  6. Once setup and webpack builds are complete, open a browser and navigate to http://localhost:8002 or use act view in a termainal to open the project in your default browser.

  For more details, see the arches-containers documentation.

Using This App in Your Arches Project

Follow these steps to add arches-he-sysref-funcs to your Arches project:

1. Add to your_project/pyproject.toml

Add the following to your pyproject.toml dependencies (in the [project] section):

arches-he-sysref-funcs @ git+https://github.com/HistoricEngland/arches-he-sysref-funcs.git@release/1.0.0

Example:

dependencies = [
    "arches==7.6.17",
    "arches-he-sysref-funcs==1.0.1" ]

2. Update your_project/your_project/settings.py

Add the following to the appropriate locations:

DATATYPE_LOCATIONS.append("arches_he_sysref_funcs.datatypes")
FUNCTION_LOCATIONS.append("arches_he_sysref_funcs.functions")
SEARCH_COMPONENT_LOCATIONS.append("arches_he_sysref_funcs.search.components")

Add to INSTALLED_APPS and ARCHES_APPLICATIONS:

INSTALLED_APPS = (
    ...
    "your_project",
    "arches_he_sysref_funcs",
)
ARCHES_APPLICATIONS = ("arches_he_sysref_funcs",)

3. Update your_project/your_project/urls.py

Include the app's URLs (add project URLs before this):

urlpatterns = [
    # ... your project urls ...
    path("", include("arches_he_sysref_funcs.urls")),
]

4. Run Database Migrations

Run the following command to apply any database migrations required by this app:

if using the arches-containers, run this in the application container

python manage.py migrate

5. Install and Build Front-End Dependencies

From the directory containing your your_project/package.json:

if using arches-containers, run this in the application container or restart the webpack

npm install
npm run build_development

6. Start Your Arches Project

python manage.py runserver

License

This project is licensed under the GNU AGPLv3. See the LICENSE file for details.

For more information on deploying your Arches project, see the Arches Deployment Guide.