Spindle

Programming language that enables you to practice AP CSP Exam code as real, live code.
⭐ Star us, it motivates us a lot!

💡 Core Principales

1. Quality: We want Spindle code look and function as close as possible to how it will on exam day
2. Simplicity: We want to make learning computer principles as simple as possible for the average student
3. Affordabilty: Not everyone has money to buy expensive study materials, as such Spindle will stay free - forever
4. Transparency: We are commited to keeping Spindle open to everyone who wishes to use it. Spindle will remain open-sourced.
5. Accessibility: Some people interested in computer science may not have access to laptops, or knowledgeable of a filesystem, so we want to make it as easy to use Spindle as possible

💻 Sample Code

 
# Displays "Hello Spindle!", but only if the user inputs an the super secret passcode
PASSCODE <-- "SHHH"
USER_PASSCODE_ATTEMPT = INPUT() 
IF (USER_PASSCODE_ATTEMPT == PASSCODE) {
    DISPLAY("Hello Spindle!")
    }
     

🔨 How To Use

Spindle can be used natively on desktop, or for ease of use, anywhere via it's website

Quick Method (Running on website)

1. Navigate to Spindle's website and click "code". Or just follow this link: https://spdl.glitch.me/code
2. Type your code in the "Code Input" box (if you don't know what to try, use the sample code above!)
3. Click the run button!

Native Method (Running on desktop)

1. Download Spindle:

   Head over to the releases section of the Spindle GitHub repository and download the latest version of the `Spindle.py` and `shell.py` files: You can find them here!

   You'll also want to download Python from its official website if you haven't already: Which you can do here!

2. Create a Project Folder:

   Create a new folder on your computer where you'll store your Spindle code. Name it whatever you like.

3. Extract Spindle Files:

   Extract the downloaded files into your project folder. You should have two files in it so far: `Spindle.py` and `shell.py`.

4. Write Your Spindle Code:

   Create a new text file within your project folder and save it with a filename ending in `.spdl` (e.g., `my_first_program.spdl`). This file will contain your Spindle code. Make sure you know the complete file name!

5. Run Your Code:

   This can be done in two ways:

   • Simple Method:
     1. Run the `shell.py` file.
     2. Type `RUN("[FILENAME].spdl")`, replacing `[FILENAME]` with the actual filename of your Spindle code file (e.g., `my_first_program.spdl`).
   • Advanced Method:
     1. Open a terminal or command prompt.
     2. Navigate to your project folder using the `cd` command.
     3. Run the below command, replacing `[FILENAME]` with the actual filename of your Spindle code file (e.g., `my_first_program.spdl`):

     python shell.py RUN("[FILENAME].spdl")

🚂 Want to Contribute?

Here's the thing about open-source software, anyone can contribute - and all meaningful contributions are valuable. You don't have to even touch any code to help us, if you find a bug, reporting it to us will help us fix it quicker. For those who do know a little code, you can help to make Spindle better for all by adding collegeboard features and pruning unnecessary ones. We'll even feature you, it's the least we could do!

🧑‍⚖️ Legal Stuff

The Spindle programming language, website, logo and brand are all licensed under the MIT license -That means it's free for you to use in relation to Spindle. If you have more questions, please read the LICENCE file and ask us!

"AP CSP" is a shorthand for " AP Computer Science Principles", which is trademarked by collegeboard. So when we mention "AP CSP", mentally replace it with "AP® CSP" Collegeboard, who is not affiliated in any mannor with this project would also like us to say the following:

AP® is a trademark registered by the College Board, which is not affiliated with, and does not endorse, this project