Metadata-Version: 2.1
Name: neuralknight
Version: 1.0.0
Summary: A Chess-playing AI
Home-page: https://www.github.com/dsnowb/neuralknight
Author: David Snowberger, Shannon Tully, and Adam Grandquist
Author-email: david.snowberger@fartherout.org
License: MIT
Keywords: chess entertainment game ai
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Games/Entertainment :: Board Games
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: License :: Freely Distributable
Classifier: Framework :: Pyramid
Classifier: Environment :: Console
Requires-Python: >=3.6
Provides-Extra: testing
Requires-Dist: cornice
Requires-Dist: plaster-pastedeploy
Requires-Dist: psycopg2-binary
Requires-Dist: pyramid (>=1.9a)
Requires-Dist: pyramid-debugtoolbar
Requires-Dist: pyramid-jinja2
Requires-Dist: pyramid-retry
Requires-Dist: pyramid-tm
Requires-Dist: pytest
Requires-Dist: pytest-cov
Requires-Dist: requests
Requires-Dist: SQLAlchemy
Requires-Dist: transaction
Requires-Dist: zope.sqlalchemy
Requires-Dist: waitress
Provides-Extra: testing
Requires-Dist: WebTest (>=1.3.1); extra == 'testing'
Requires-Dist: pytest; extra == 'testing'
Requires-Dist: pytest-cov; extra == 'testing'
Requires-Dist: requests; extra == 'testing'

# neuralknight

**Authors**: David Snowberger, Shannon Tully, Adam Grandquist

**Version**: 1.0.0

## Overview
An occasionally suicidal shell-based chess game.

## Getting Started

### Requirements
- Python 3.5 or greater
- pip package manager

### Installation
Installation is as simple as installing from pip:
`pip install neuralknight`

#### Running the app
To launch neuralknight, type the following into a shell:
`neuralknight https://neuralknight.herokuapp.com`

Should you wish to run a purely local instance:

- Download the source from [here](https://www.github.com/dsnowb/neuralknight)

- Create a postgres database named *neuralknight*

From inside the source directory:

- Initialize the database with `initialize_neuralknight_db`

- Launch the local server with
`pserve production.ini`
- In another shell, run the client with `neuralknight`

## Architecture
This app is written using Python 3.6, Pyramid, and Postgres, with Heroku as a deployment platform

## API
See our API docs [here](https://github.com/dsnowb/neuralknight/blob/master/API.md)

## Change Log
- 05 April 2018 - Repo Created
- 19 April 2018 - 1.0.0 release


0.1.0
---

- Initial version.


