Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arthurosipyan/jamascript
JamaScript, your personal data assistant
https://github.com/arthurosipyan/jamascript
blueprint data-analysis data-mining data-science exceldatareader jama jama-api python python-3 python-script python3
Last synced: about 1 month ago
JSON representation
JamaScript, your personal data assistant
- Host: GitHub
- URL: https://github.com/arthurosipyan/jamascript
- Owner: arthurosipyan
- License: mit
- Created: 2018-08-24T13:46:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-27T15:35:06.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T12:22:13.144Z (8 months ago)
- Topics: blueprint, data-analysis, data-mining, data-science, exceldatareader, jama, jama-api, python, python-3, python-script, python3
- Language: Python
- Homepage:
- Size: 123 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 
## Table of Contents:
- [Required](https://github.com/arthurosipyan/JamaScript#required)
- [Setup](https://github.com/arthurosipyan/JamaScript#setup)
- [Running JamaScript](https://github.com/arthurosipyan/JamaScript#running-jamascript)
- [Excel File Format](https://github.com/arthurosipyan/JamaScript#excel-file-format)
- [Additional Notes](https://github.com/arthurosipyan/JamaScript#additional-notes)
- [Author](https://github.com/arthurosipyan/JamaScript#author)
- [License and Code of Conduct](https://github.com/arthurosipyan/JamaScript#license-and-code-of-conduct)
- [Feedback](https://github.com/arthurosipyan/JamaScript#feedback)
## Required:
- [Jama Account](https://www.jamasoftware.com/get-started/)
- [Client Credentials](http://help.jamasoftware.com/ah/en/get-started/manage-your-profile/set-api-credentials.html)
- [Microsoft Excel](https://www.microsoft.com/en-us/store/b/excel-2016?&OCID=AID718530_SEM_xnbrT3OI&gclid=EAIaIQobChMIrq6vo7eS3QIVl1cNCh2kFAvLEAAYASAAEgJdYfD_BwE)
## Setup:
1. Download [JamaScript](https://github.com/arthurosipyan/JamaScript/releases/download/v0.5.1-alpha/JamaScript.exe)
4. Enter both your client credentials and **company name** (https://{**company name**}.jamacloud.com)
5. Say hello to JamaScript, your personal migrate assistant!
**Note:** JamaScript will need to be optomized according to your projects settings. For example, every project contains different numerical keys for item types and sets.
## Running JamaScript:
- Once logged in, you will be asked for a ```Project API_ID```. This can be found when viewing one of your Jama projects.
- After confirming the project you'd like to work on, you will be prompt with a few options:
1. Add main components with their sets
- This will ask for a components file and do a basic setup, which includes a set of:
- Use Cases
- Functional Requirements
- Non-Functional Requirements
- Technical Requirements
- Test Cases and Defects with a parent component named "Test Management"
2. Add artifacts
- This will ask you to select what type of artifact you'd like to import
- After selecting an artifact type, you will be asked for the target item's ```ID```, which is where everything will be imported
- Finally, you'll be asked for a file to be read. Make sure to follow the correct [file format](https://github.com/arthurosipyan/JamaScript#excel-file-format)!
3. Change project
- Change the current project being worked on
## Excel File Format:
| Artifact Types | Col 1 | Col 2 | Col 3 | Col 4 | Col 5 | Col 6 |
| -------------------|:-----:|:------------:|:------------:|:-------------:|:--------------:|:------------:|
| **Components** | Name | | | | | |
| **Use Cases** | Name | PreCondition | MainFlow | PostCondition | AlternateFlows | Blueprint_ID |
| **Requirements** | Name | Description | Blueprint_ID | | | |
| **Wireframes** | Name | Blueprint_ID | | | | |
| **Documents** | Name | Description | Blueprint_ID | | | |
**Note:** Blank cells need to have some data for the file to be read. This can be fixed with some placeholder text.
## Additional Notes:
- Image and Attachment imports are currently unavailable
- Refrain from starting your text with a number, as it causes a known issue
## Author
* **Arthur Osipyan** - *Software Engineer*
## License and Code of Conduct
- This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/arthurosipyan/JamaScript/blob/master/LICENSE) file for details
- This project's Code of Conduct can be found [here](https://github.com/arthurosipyan/JamaScript/blob/master/CODE_OF_CONDUCT.md)
## Feedback
- Found a bug or want to imporve JamaScript? Submit [here](https://github.com/arthurosipyan/JamaScript/issues)!