Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update install docs #35

Merged
merged 6 commits into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to PyVet

Welcome, and thank you for wanting to contribute to `pyvet`! This is a python
library that helps organizations, companies, and even veterans themselves
analyze and research data from the Department of Veterans Affairs. This
document outlines the quickest way to start contributing and get familiar
with the code base.

## Local clone and code navigation

Follow the below if to contribute:

1. [Installation & Environment](/docs/how-to/installation.md)
2. [Code layout](/docs/reference/architecture.md)
3. [Style](/docs/reference/style.md)
4. [Tests](/docs/how-to/run_tests.md)

## Features and Bugs

Before you start working on a change, visit the
[issues](https://github.com/cterrazas2/pyvet/issues) and
[pull-requests](https://github.com/cterrazas2/pyvet/pulls) tabs and see if there
is something already related to your change. If not, then once your change is
completed locally, in your own branch, ensure all tests pass (and add
tests to your change), and then create a pull request filled out with all the
pertinent information.
38 changes: 26 additions & 12 deletions docs/how-to/installation.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
# Install

## Required software

* [Python](https://www.python.org/downloads/) 3.10+
* [Poetry](https://poetry.eustace.io/docs/#installation)

## Poetry

PyVet uses [Poetry](https://python-poetry.org) for management of dependencies
and virtual environments. First, use `poetry install` to install the
dependencies, then run `poetry shell` to activate the virtual environment.

## Pip

To install the `pyvet` package run the following:
To begin using `pyvet` run the following:

```console
pip install pyvet
```

Check out the [Jupyter notebook](/docs/tutorials/explore_pyvet.ipynb)
for some examples if you just want to get up and running quickly.

## Required software for local development

* [Python](https://www.python.org/downloads/) 3.10+
* [Poetry](https://poetry.eustace.io/docs/#installation)

## Git

Clone the `pyvet` git repo.
Expand All @@ -32,3 +29,20 @@ Or use the `gh` cli:
```console
gh clone git@github.com:cterrazas2/pyvet.git
```

## Poetry

PyVet uses [Poetry](https://python-poetry.org) for management of dependencies
and virtual environments. To install the dependencies, run

```console
poetry install
```

then

```console
poetry poetry shell
```

to activate the virtual environment.
7 changes: 0 additions & 7 deletions docs/reference/architecture.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
# PyVet Architecture

`pyvet` is a python library that helps organizations, companies, and even
veterans themselves analyze and research data from the Department of Veterans
Affairs. This document outlines the quickest way to start contributing and
get familiar with the code base.

## Code Setup

```console
/pyvet # This is where the main code lives
/benefits # The VA Benefits APIs
Expand Down