DevelopmentSetup.md

Development Setup

Introduction

This page describes how to set up a development environment, and other information useful for developers to be aware of.

Prerequisites

The following instructions assume that "pyenv" is installed to enable the setup of an isolated Python environment.

See the following for setup instructions:

• https://github.com/pyenv/pyenv

Installation for development

1. Clone the "aws-archiver" Git repository:

$ git clone [email protected]:umd-lib/aws-archiver.git

2. Switch to the "aws-archiver" directory:

$ cd aws-archiver

3. Set up the virtual environment:

$ pyenv install --skip-existing $(cat .python-version)
$ python -m venv .venv --prompt aws-archiver
$ source .venv/bin/activate

4. Run "pip install", including the "dev" and "test" dependencies:

$ pip install -e .'[dev,test]'

Running the Tests

The unit tests for the application can be run using "pytest", i.e.:

$ pytest

Code Style

Application code style should generally conform to the guidelines in PEP 8. The "pycodestyle" tool to check compliance with the guidelines can be run using:

$ pycodestyle .