Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gkapfham/seed

:seedling: Seed is a Python Package for Analyzing the Responses to the SEED Survey
https://github.com/gkapfham/seed

gensim python python3 simpleform

Last synced: 2 days ago
JSON representation

:seedling: Seed is a Python Package for Analyzing the Responses to the SEED Survey

Awesome Lists containing this project

README 

        
# SEED: Educational Discussions with Software Engineers



SEED is a Python 3 program that analyzes and visualizes a data set for the [SEED

Project](http://www.cs.allegheny.edu/sites/gkapfham/seed/) created by [Gregory

M. Kapfhammer](http://www.cs.allegheny.edu/sites/gkapfham/). With required

tokens, it can be used to download the responses of the interviewees who

participated in the SEED project. Additionally, you can use SEED to see the

interviewees' responses and to perform natural language processing to extract

the key topic models. This program is currently under heavy development; more

extensive documentation is forthcoming.



## Installation



As a Python 3 program, SEED relies on

[pip](https://pip.pypa.io/en/stable/installing/) for installation. To ensure

that all of the dependencies are installed correctly, please type the following

commands before running SEED.



- `pip install --upgrade pip`

- `pip install -r requirements.txt`



Note that you may have Python 3 setup in different ways on your computer. For

instance, you may prefer to install SEED's dependencies in a site-wide

location and then you would have to type, for instance, `sudo pip install -r

requirements.txt`. Alternatively, you may choose to install the dependencies by

typing `pip install --user -r requirements.txt`.



SEED was developed to easily run in conjunction with a [venv-based Python 3

virtual environment](https://docs.python.org/3/library/venv.html). This means

that if you are in the directory that contains the `seed` directory then you

could type `python3 -m venv seed` to create all of the components of a

venv-based virtual environment in the `seed` directory. Once you complete this

step, you can type the command `source seed/bin/activate` to activate the

venv-based virtual environment. Interested in learning more about the basics of

virtual environments in Python 3? You can read this

[article](http://www.cs.allegheny.edu/sites/gkapfham/programming/research/idea/2017/07/14/Virtual-Environments/)

to further develop your understanding of this topic.



## Testing SEED



SEED uses [Pytest](https://docs.pytest.org/en/latest/) for testing. To run

SEED's test suite, please type `pytest tests` in the root of the project's

repository. If any of the test cases fail in your development environment,

please please raise an issue in SEED's issue tracker.



Please note that some of SEED's test cases require you to have a private access

token stored in the `SEED_SIMPLEFORM_TOKEN` environment variable. By necessity,

this token is kept private and only known to the developer of this program. As

such, these test cases will be skipped when you run the aforementioned command.



Moreover, SEED contains some test cases that normally take a longer time to run

because of the fact that they invoke functions that use natural language

processing libraries. If you would also like to run those tests along with those

that complete more quickly, then you can type `pytest tests --runslow`.



## Using SEED



Before using this Python 3 program, please make sure that you follow the

instructions to install it and check its correctness by running its test suite.

If you would like to learn more about how to use SEED, please type `python3

seed.py --help` and review the command-line options. If you would, for instance,

like to see who has responded to the SEED survey by processing the provided

`seed.json` file you can type `python3 seed.py --show-respondents`.



## Problems or Praise



If you have any problems with installing or using SEED, then please create an

issue associated with this Git repository using the "Issues" link at the top of

this site. I will do everything that I can to resolve your issue and ensure that

the entire tool works well in your own development environment.