From c1ccc122539c73c984e31f39f885f746ef201a85 Mon Sep 17 00:00:00 2001 From: iiPython Date: Sat, 9 Mar 2024 18:14:35 -0600 Subject: [PATCH] [docs] Mass migration to mdbook --- .github/workflows/mdbook.yml | 32 ++++ .gitignore | 3 + CNAME | 1 + README.md | 35 ++-- docs/README.md | 158 ++++++++++++++++++ docs/SUMMARY.md | 22 +++ docs/book.toml | 9 + docs/caffeine.md | 14 +- docs/documents.md | 48 +++--- docs/documents/comments.md | 26 +-- docs/documents/comparators.md | 25 +-- .../{configurations.md => configuration.md} | 33 ++-- docs/documents/{dataTypes.md => datatypes.md} | 26 +-- docs/documents/operators.md | 25 +-- docs/documents/packages.md | 27 +-- docs/documents/sections.md | 25 +-- docs/documents/variables.md | 27 +-- docs/{pythonAPI.md => python-api.md} | 12 +- docs/standardLibrary.md | 0 docs/standardLibrary/array.md | 0 docs/standardLibrary/colors.md | 0 docs/standardLibrary/object.md | 0 docs/standardLibrary/stdlib.md | 0 docs/stdlib.md | 21 +++ docs/tutorials.md | 32 ++-- docs/tutorials/{3branches.md => branching.md} | 26 +-- .../{4calculator.md => calculator.md} | 24 +-- .../{1helloWorld.md => hello-world.md} | 24 +-- .../{2userInput.md => user-input.md} | 24 +-- pyproject.toml | 4 +- {caffeine => src/caffeine}/__init__.py | 0 {caffeine => src/caffeine}/__main__.py | 0 .../caffeine}/modules/__init__.py | 0 .../caffeine}/modules/exceptions.py | 0 .../caffeine}/modules/operators/__init__.py | 0 .../caffeine}/modules/operators/fileio.py | 0 .../caffeine}/modules/operators/internal.py | 0 .../caffeine}/modules/operators/math.py | 0 .../caffeine}/modules/operators/objects.py | 0 .../caffeine}/modules/operators/stdio.py | 0 .../caffeine}/modules/operators/strman.py | 0 .../caffeine}/modules/optimize.py | 0 {tests => src/tests}/__init__.py | 0 {tests => src/tests}/test_compare.py | 0 {tests => src/tests}/test_file.py | 0 {tests => src/tests}/test_math.py | 0 {xpp => src/xpp}/__init__.py | 0 {xpp => src/xpp}/__main__.py | 0 {xpp => src/xpp}/core/datastore.py | 0 {xpp => src/xpp}/core/interpreter.py | 0 {xpp => src/xpp}/core/sections.py | 0 {xpp => src/xpp}/core/tokenizer.py | 0 {xpp => src/xpp}/exceptions.py | 0 {xpp => src/xpp}/extra/config.py | 0 {xpp => src/xpp}/modules/ops/__init__.py | 0 {xpp => src/xpp}/modules/ops/shared.py | 0 {xpp => src/xpp}/modules/ops/stdlib/fileio.py | 0 .../xpp}/modules/ops/stdlib/import_.py | 0 .../xpp}/modules/ops/stdlib/internal.py | 0 {xpp => src/xpp}/modules/ops/stdlib/math.py | 0 .../xpp}/modules/ops/stdlib/objects.py | 0 {xpp => src/xpp}/modules/ops/stdlib/stdio.py | 0 {xpp => src/xpp}/modules/ops/stdlib/strman.py | 0 {xpp => src/xpp}/modules/simpleeval.py | 0 64 files changed, 481 insertions(+), 222 deletions(-) create mode 100644 .github/workflows/mdbook.yml create mode 100644 CNAME create mode 100644 docs/README.md create mode 100644 docs/SUMMARY.md create mode 100644 docs/book.toml rename docs/documents/{configurations.md => configuration.md} (63%) rename docs/documents/{dataTypes.md => datatypes.md} (92%) rename docs/{pythonAPI.md => python-api.md} (95%) delete mode 100644 docs/standardLibrary.md delete mode 100644 docs/standardLibrary/array.md delete mode 100644 docs/standardLibrary/colors.md delete mode 100644 docs/standardLibrary/object.md delete mode 100644 docs/standardLibrary/stdlib.md create mode 100644 docs/stdlib.md rename docs/tutorials/{3branches.md => branching.md} (83%) rename docs/tutorials/{4calculator.md => calculator.md} (87%) rename docs/tutorials/{1helloWorld.md => hello-world.md} (86%) rename docs/tutorials/{2userInput.md => user-input.md} (83%) rename {caffeine => src/caffeine}/__init__.py (100%) rename {caffeine => src/caffeine}/__main__.py (100%) rename {caffeine => src/caffeine}/modules/__init__.py (100%) rename {caffeine => src/caffeine}/modules/exceptions.py (100%) rename {caffeine => src/caffeine}/modules/operators/__init__.py (100%) rename {caffeine => src/caffeine}/modules/operators/fileio.py (100%) rename {caffeine => src/caffeine}/modules/operators/internal.py (100%) rename {caffeine => src/caffeine}/modules/operators/math.py (100%) rename {caffeine => src/caffeine}/modules/operators/objects.py (100%) rename {caffeine => src/caffeine}/modules/operators/stdio.py (100%) rename {caffeine => src/caffeine}/modules/operators/strman.py (100%) rename {caffeine => src/caffeine}/modules/optimize.py (100%) rename {tests => src/tests}/__init__.py (100%) rename {tests => src/tests}/test_compare.py (100%) rename {tests => src/tests}/test_file.py (100%) rename {tests => src/tests}/test_math.py (100%) rename {xpp => src/xpp}/__init__.py (100%) rename {xpp => src/xpp}/__main__.py (100%) rename {xpp => src/xpp}/core/datastore.py (100%) rename {xpp => src/xpp}/core/interpreter.py (100%) rename {xpp => src/xpp}/core/sections.py (100%) rename {xpp => src/xpp}/core/tokenizer.py (100%) rename {xpp => src/xpp}/exceptions.py (100%) rename {xpp => src/xpp}/extra/config.py (100%) rename {xpp => src/xpp}/modules/ops/__init__.py (100%) rename {xpp => src/xpp}/modules/ops/shared.py (100%) rename {xpp => src/xpp}/modules/ops/stdlib/fileio.py (100%) rename {xpp => src/xpp}/modules/ops/stdlib/import_.py (100%) rename {xpp => src/xpp}/modules/ops/stdlib/internal.py (100%) rename {xpp => src/xpp}/modules/ops/stdlib/math.py (100%) rename {xpp => src/xpp}/modules/ops/stdlib/objects.py (100%) rename {xpp => src/xpp}/modules/ops/stdlib/stdio.py (100%) rename {xpp => src/xpp}/modules/ops/stdlib/strman.py (100%) rename {xpp => src/xpp}/modules/simpleeval.py (100%) diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml new file mode 100644 index 0000000..59ac026 --- /dev/null +++ b/.github/workflows/mdbook.yml @@ -0,0 +1,32 @@ +name: Publish mdbook to GitHub Pages + +on: + push: + paths: ["docs/**"] + + workflow_dispatch: + +jobs: + deploy: + runs-on: ubuntu-20.04 + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + + steps: + - uses: actions/checkout@v2 + + - name: Setup mdBook + uses: peaceiris/actions-mdbook@v1 + with: + mdbook-version: "latest" + + - run: | + cd docs + mdbook build + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.ref == 'refs/heads/main' }} + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/book diff --git a/.gitignore b/.gitignore index db3694f..8880e58 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,9 @@ __pycache__/ pkgs/* !pkgs/stdlib +# Hide mdbook build +docs/book/ + # Everything pip related dist/ build/ diff --git a/CNAME b/CNAME new file mode 100644 index 0000000..d41a8ab --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +xpp.iipython.dev \ No newline at end of file diff --git a/README.md b/README.md index e3c6701..fa305c3 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@

an interpreted, minimalistic programming language

- License - Downloads - Last commit - Repo size - Stars + License + Downloads + Last commit + Repo size + Stars
@@ -34,10 +34,10 @@ Welcome to the official documentation for x++! This documentation will get you s - [Credits and Links ▾](#credits--links) - [Contributors](#contributors) - [Resources](#resources) -- [Tutorials](./docs/tutorials.md) -- [Documents](./docs/documents.md) -- [Python API](./docs/pythonAPI.md) -- [Standard Library](./docs/standardLibrary.md) +- [Tutorials](https://xpp.iipython.dev/tutorials.html) +- [Documents](https://xpp.iipython.dev/documents.html) +- [Python API](https://xpp.iipython.dev/python-api.html) +- [Standard Library](https://xpp.iipython.dev/stdlib.html)

@@ -77,6 +77,13 @@ Next, visit our [github repository](https://github.com/iiPythonx/xpp/) and downl git clone https://github.com/iiPythonx/xpp ``` +To install xpp system-wide, run the following: +``` +pip install . +``` + +You will now have the `xpp` command available for use. + If you are choosing Visual Studio Code as your Integrated Development Environment, you can also install the [x++ extension](https://marketplace.visualstudio.com/items?itemName=iiPython.xpp) on the marketplace to get syntax highlighting on your x++ files. ### Step 2: Set-Up @@ -98,14 +105,14 @@ You can edit the main entry file by editing the configuration in `.xconfig`. It } ``` -> You can learn more about setting up your project in the [tutorials](./docs/tutorials.md). +> You can learn more about setting up your project in the [tutorials](https://xpp.iipython.dev/tutorials.html). ### Step 3: Execution After you are done writing your x++ code, you can execute your x++ project immediately by opening up a terminal and typing: ``` -python main.py . +xpp . ``` Currently, you should see the terminal output: @@ -113,7 +120,7 @@ Currently, you should see the terminal output: ``` "Hello, world!" ``` -> You can also compile your xpp code into Python using [caffeine](./docs/caffeine.md). +> You can also compile your xpp code into Python using [caffeine](https://xpp.iipython.dev/caffeine.html).

@@ -127,7 +134,7 @@ Starting on March 6th, 2023, x2 was deprecated in favor of x++ as the language w ### Q: Can I use x++ for data management, game design, or simply for fun? -Most of the things you could think of making are able to be created within x++. However, you can also supercharge xpp with the power of Python; [see here](./docs/pythonAPI.md). +Most of the things you could think of making are able to be created within x++. However, you can also supercharge xpp with the power of Python; [see here](https://xpp.iipython.dev/python-api.html).

@@ -146,6 +153,6 @@ Most of the things you could think of making are able to be created within x++. --- -Last Updated: December 2nd, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#introduction) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..688e170 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,158 @@ +
+

xpp

+
+

an interpreted, minimalistic programming language

+ License + Downloads + Last commit + Repo size + Stars +
+
+ + +

+ Introduction +

+ +Welcome to the official documentation for x++! This documentation will get you started in the development of your first x++ project or will help you learn more about x++ in general with in-depth explanations and tutorials. + + +

+ Table of Contents +

+ +- **Home ▾** + - [Introduction](#introduction) + - [ToC](#table-of-contents) + - [About](#about) + - [Getting Started ▾](#getting-started) + - [Step 1: Installation](#step-1-installation) + - [Step 2: Set-Up](#step-2-set-up) + - [Step 3: Execution](#step-3-execution) + - [Frequently Asked Questions](#frequently-asked-questions) + - [Credits and Links ▾](#credits--links) + - [Contributors](#contributors) + - [Resources](#resources) +- [Tutorials](tutorials.md) +- [Documents](documents.md) +- [Python API](python-api.md) +- [Standard Library](stdlib.md) + + +

+ About +

+ +x++ (Pronounced "ex-plus-plus") is a high-level, interpreted language written in Python by [iiPython](https://github.com/iiPythonx) with low-level syntax, similar to that of [x86 Assembly](https://en.wikipedia.org/wiki/X86_assembly_language) (and additionally inspired by [Batch](https://en.wikipedia.org/wiki/Batch_file)). + +x++ contains features such as: +- Automatic garbage collection +- Scoped/file/global variables +- Sectioning/function system +- Mature python integration +- Import/export/module system +- Object-oriented programming through the use of files +- ... much more! + + +

+ Getting Started +

+ +### Step 1: Installation + +First and foremost, make sure you have [Python](https://python.org/downloads/) (Python 3.10 is required, however we recommend 3.11+) installed on your device. You can check if you have Python installed by opening up a terminal and typing: + +``` +python3 -V +``` +(on NT* platforms, replace `python3` with `py`) + +It is highly recommended to have a text editor or Integrated Development Environment, such as [Visual Studio Code](https://code.visualstudio.com/), as its built-in development tools and add-ons will speed up and facilitate your development process. However, a simple text editor like notepad is sufficient. + +Next, visit our [github repository](https://github.com/iiPythonx/xpp/) and download a clone of the repository by clicking on the green `Code ▾` button and the `Download ZIP` option. Optionally, if you have [git](https://git-scm.com/) installed on your device, you can also clone the repository by opening up a terminal and typing: + +``` +git clone https://github.com/iiPythonx/xpp +``` + +To install xpp system-wide, run the following: +``` +pip install . +``` + +You will now have the `xpp` command available for use. + +If you are choosing Visual Studio Code as your Integrated Development Environment, you can also install the [x++ extension](https://marketplace.visualstudio.com/items?itemName=iiPython.xpp) on the marketplace to get syntax highlighting on your x++ files. + +### Step 2: Set-Up + +Once you open up your x++ project, you should be able to find a file named `main.xpp`. By default, this is your main entry file and is where you will be writing your x++ code. Within the file, you should see an example program similar to: + +```xpp +:: Main +prt "Hello, world!" +``` + +Any x++ files should always end in the `.xpp` extension. + +You can edit the main entry file by editing the configuration in `.xconfig`. It is a JSON-like file that contains all the configurations for your x++ project. Within it, you should see: + +```xconfig +{ + "main": "main.xpp" +} +``` + +> You can learn more about setting up your project in the [tutorials](tutorials.md). + +### Step 3: Execution + +After you are done writing your x++ code, you can execute your x++ project immediately by opening up a terminal and typing: + +``` +python main.py . +``` + +Currently, you should see the terminal output: + +``` +"Hello, world!" +``` +> You can also compile your xpp code into Python using [caffeine](caffeine.md). + + +

+ Frequently Asked Questions +

+ +### Q: Why is it called x++? + +The language originally started as the "X Programming Language" because the name sounded cool. As development went on, a second revision was published and the name was changed to `x2`. +Starting on March 6th, 2023, x2 was deprecated in favor of x++ as the language was beginning to undergo major changes. + +### Q: Can I use x++ for data management, game design, or simply for fun? + +Most of the things you could think of making are able to be created within x++. However, you can also supercharge xpp with the power of Python; [see here](python-api.md). + + +

+ Credits & Links +

+ +### Contributors + +- [iiPython](https://github.com/iiPythonx) - Developer, Documentation +- [DmmD Gaming](https://github.com/DmmDGM) - Original Documentation, Ideas, & Standard Library + +### Resources + +- [Github Repository](https://github.com/iiPythonx/xpp) +- [Visual Studio Code x++ Extension](https://marketplace.visualstudio.com/items?itemName=iiPython.xplusplus) + +--- + +Last Updated: December 2nd, 2023 by iiPython + +[↑ Go To Top](#introduction) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..c7c148f --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,22 @@ +# Summary + +[Introduction](README.md) + +# Reference Guide +- [Tutorials](tutorials.md) + - [Hello, world!](tutorials/hello-world.md) + - [User Input](tutorials/user-input.md) + - [Branching](tutorials/branching.md) + - [Calculator](tutorials/calculator.md) +- [Documents](documents.md) + - [Comments](documents/comments.md) + - [Comparators](documents/comparators.md) + - [Configuration](documents/configuration.md) + - [Data Types](documents/datatypes.md) + - [Operators](documents/operators.md) + - [Packages](documents/packages.md) + - [Sections](documents/sections.md) + - [Variables](documents/variables.md) +- [Python API](python-api.md) +- [Caffeine](caffeine.md) +- [Standard Library](stdlib.md) diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..932b79c --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,9 @@ +[book] +title = "x++ Documentation" +description = "An interpreted, minimalistic programming language." +authors = ["iiPython"] +language = "en" +src = "./" + +[output.html] +git-repository-url = "https://github.com/iiPythonx/xpp" diff --git a/docs/caffeine.md b/docs/caffeine.md index f1366c5..fdbeebe 100644 --- a/docs/caffeine.md +++ b/docs/caffeine.md @@ -1,14 +1,14 @@ -# [x++](../README.md) / Caffeine +# [x++](README.md) / Caffeine ## Table of Contents -- [Home](../README.md) -- [Tutorials](./tutorials.md) -- [Documents](./documents.md) -- [Python API](./pythonAPI.md) +- [Home](README.md) +- [Tutorials](tutorials.md) +- [Documents](documents.md) +- [Python API](python-api.md) - **Caffeine ▾** - [Introduction](#introduction) -- [Standard Library](./standardLibrary.md) +- [Standard Library](stdlib.md) ## Introduction @@ -16,6 +16,6 @@ This document is coming soon. --- -Last Updated: July 5th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--caffeine) \ No newline at end of file diff --git a/docs/documents.md b/docs/documents.md index d8e5051..bda122f 100644 --- a/docs/documents.md +++ b/docs/documents.md @@ -1,44 +1,44 @@ -# [x++](../README.md) / Documents +# [x++](README.md) / Documents ## Table of Contents -- [Home](../README.md) -- [Tutorials](./tutorials.md) +- [Home](README.md) +- [Tutorials](tutorials.md) - **Documents ▾** - [Table of Contents](#table-of-contents) - [About](#about) - [Documents ▾](#documents) - - [Comments](./documents/comments.md) - - [Comparators](./documents/comparators.md) - - [Configurations](./documents/configurations.md) - - [Data Types](./documents/dataTypes.md) - - [Operators](./documents/operators.md) - - [Packages](./documents/packages.md) - - [Sections](./documents/sections.md) - - [Variables](./documents/variables.md) -- [Python API](./pythonAPI.md) -- [Caffeine](./caffeine.md) -- [Standard Library](./standardLibrary.md) + - [Comments](documents/comments.md) + - [Comparators](documents/comparators.md) + - [Configuration](documents/configuration.md) + - [Data Types](documents/datatypes.md) + - [Operators](documents/operators.md) + - [Packages](documents/packages.md) + - [Sections](documents/sections.md) + - [Variables](documents/variables.md) +- [Python API](python-api.md) +- [Caffeine](caffeine.md) +- [Standard Library](stdlib.md) ## About Welcome to the documents page of the official x++ documentation. In this section, you will be learning about the individual components that make up x++. -If you are looking for a beginner's guide for x++, check out the [tutorials](./tutorials.md) instead. +If you are looking for a beginner's guide for x++, check out the [tutorials](tutorials.md) instead. ## Documents -- ### [Comments](./documents/comments.md) -- ### [Comparators](./documents/comparators.md) -- ### [Configurations](./documents/configurations.md) -- ### [Data Types](./documents/dataTypes.md) -- ### [Operators](./documents/operators.md) -- ### [Packages](./documents/packages.md) -- ### [Sections](./documents/sections.md) -- ### [Variables](./documents/variables.md) +- [Comments](documents/comments.md) +- [Comparators](documents/comparators.md) +- [Configuration](documents/configuration.md) +- [Data Types](documents/datatypes.md) +- [Operators](documents/operators.md) +- [Packages](documents/packages.md) +- [Sections](documents/sections.md) +- [Variables](documents/variables.md) --- -Last Updated: July 5th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--documents) \ No newline at end of file diff --git a/docs/documents/comments.md b/docs/documents/comments.md index e18f4f6..b8e7b68 100644 --- a/docs/documents/comments.md +++ b/docs/documents/comments.md @@ -1,8 +1,8 @@ -# [x++](../../README.md) / [Documents](../documents.md) / Comments +# [x++](../README.md) / [Documents](../documents.md) / Comments ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - [Documents ▾](../documents.md) - [Table of Contents](../documents.md#table-of-contents) @@ -11,16 +11,16 @@ - **Comments ▾** - [Table of Contents](#table-of-contents) - [About](#about) - - [Comparators](./comparators.md) - - [Configurations](./configurations.md) - - [Data Types](./dataTypes.md) - - [Operators](./operators.md) - - [Packages](./packages.md) - - [Python API](./pythonAPI.md) - - [Sections](./sections.md) - - [Variables](./variables.md) -- [Python API](../pythonAPI.md) -- [Standard Library](../standardLibrary.md) + - [Comparators](comparators.md) + - [Configuration](configuration.md) + - [Data Types](datatypes.md) + - [Operators](operators.md) + - [Packages](packages.md) + - [Sections](sections.md) + - [Variables](variables.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## About @@ -35,6 +35,6 @@ prt 5 :: This is an inline comment --- -Last Updated: July 5th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--documents--comments) \ No newline at end of file diff --git a/docs/documents/comparators.md b/docs/documents/comparators.md index 52bd8fc..55f5365 100644 --- a/docs/documents/comparators.md +++ b/docs/documents/comparators.md @@ -1,27 +1,28 @@ -# [x++](../../README.md) / [Documents](../documents.md) / Comparators +# [x++](../README.md) / [Documents](../documents.md) / Comparators ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - [Documents ▾](../documents.md) - [Table of Contents](../documents.md#table-of-contents) - [About](../documents.md#about) - [Documents ▾](../documents.md#documents) - - [Comments](./comments.md) + - [Comments](comments.md) - **Comparators ▾** - [Table of Contents](#table-of-contents) - [Catalog](#catalog) - [About](#about) - [Documentation](#documentation) - - [Configurations](./configurations.md) - - [Data Types](./dataTypes.md) - - [Operators](./operators.md) - - [Packages](./packages.md) - - [Sections](./sections.md) - - [Variables](./variables.md) -- [Python API](../pythonAPI.md) -- [Standard Library](../standardLibrary.md) + - [Configuration](configuration.md) + - [Data Types](datatypes.md) + - [Operators](operators.md) + - [Packages](packages.md) + - [Sections](sections.md) + - [Variables](variables.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## Catalog @@ -278,6 +279,6 @@ if (5 is "int") "prt 'true'" --- -Last Updated: April 9th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--documents--comparators) \ No newline at end of file diff --git a/docs/documents/configurations.md b/docs/documents/configuration.md similarity index 63% rename from docs/documents/configurations.md rename to docs/documents/configuration.md index 1018c88..be2cf9e 100644 --- a/docs/documents/configurations.md +++ b/docs/documents/configuration.md @@ -1,27 +1,28 @@ -# [x++](../../README.md) / [Documents](../documents.md) / Configurations +# [x++](../README.md) / [Documents](../documents.md) / Configuration ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - [Documents ▾](../documents.md) - [Table of Contents](../documents.md#table-of-contents) - [About](../documents.md#about) - [Documents ▾](../documents.md#documents) - - [Comments](./comments.md) - - [Comparators](./comparators.md) - - **Configurations ▾** + - [Comments](comments.md) + - [Comparators](comparators.md) + - **Configuration ▾** - [Table of Contents](#table-of-contents) - [Catalog](#catalog) - [About](#about) - [Documentation](#documentation) - - [Data Types](./dataTypes.md) - - [Operators](./operators.md) - - [Packages](./packages.md) - - [Sections](./sections.md) - - [Variables](./variables.md) -- [Python API](../pythonAPI.md) -- [Standard Library](../standardLibrary.md) + - [Data Types](datatypes.md) + - [Operators](operators.md) + - [Packages](packages.md) + - [Sections](sections.md) + - [Variables](variables.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## Catalog @@ -31,7 +32,7 @@ ## About -The configuration file defines what the project would do on execution. It is always placed in the `.xtconfig` file and should be written as if it is within a `*.json` file. If one is not found in the project, the default configuration is used internally instead: +The configuration file defines what the project would do on execution. It is always placed in the `.xconfig` file and should be written as if it is within a `*.json` file. If one is not found in the project, the default configuration is used internally instead: ```xconfig { @@ -48,8 +49,8 @@ The configuration file can also contain non-essential information, such as the a "contributor A", "contributor B" ], "description": "This is my x++ project", - "main": "main.xt", - "name": "my-x++-project", + "main": "main.xpp", + "name": "my-xpp-project", "version": "1.0.0" } ``` @@ -74,6 +75,6 @@ Defines the path of the main entry file. --- -Last Updated: April 9th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--documents--configurations) \ No newline at end of file diff --git a/docs/documents/dataTypes.md b/docs/documents/datatypes.md similarity index 92% rename from docs/documents/dataTypes.md rename to docs/documents/datatypes.md index 06bc6ea..02f8158 100644 --- a/docs/documents/dataTypes.md +++ b/docs/documents/datatypes.md @@ -1,28 +1,28 @@ -# [x++](../../README.md) / [Documents](../documents.md) / Data Types +# [x++](../README.md) / [Documents](../documents.md) / Data Types ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - [Documents ▾](../documents.md) - [Table of Contents](../documents.md#table-of-contents) - [About](../documents.md#about) - [Documents ▾](../documents.md#documents) - - [Comments](./comments.md) - - [Comparators](./comparators.md) - - [Configurations](./configurations.md) + - [Comments](comments.md) + - [Comparators](comparators.md) + - [Configuration](configuration.md) - **Data Types ▾** - [Table of Contents](#table-of-contents) - [Catalog](#catalog) - [About](#about) - [Documentation](#documentation) - - [Operators](./operators.md) - - [Packages](./packages.md) - - [Python API](./pythonAPI.md) - - [Sections](./sections.md) - - [Variables](./variables.md) -- [Python API](../pythonAPI.md) -- [Standard Library](../standardLibrary.md) + - [Operators](operators.md) + - [Packages](packages.md) + - [Sections](sections.md) + - [Variables](variables.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## Catalog @@ -231,6 +231,6 @@ if "abc" < "cba" "prt 'true'" --- -Last Updated: April 9th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--documents--data-types) \ No newline at end of file diff --git a/docs/documents/operators.md b/docs/documents/operators.md index 2ad2c06..bf32df6 100644 --- a/docs/documents/operators.md +++ b/docs/documents/operators.md @@ -1,27 +1,28 @@ -# [x++](../../README.md) / [Documents](../documents.md) / Operators +# [x++](../README.md) / [Documents](../documents.md) / Operators ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - [Documents ▾](../documents.md) - [Table of Contents](../documents.md#table-of-contents) - [About](../documents.md#about) - [Documents ▾](../documents.md#documents) - - [Comments](./comments.md) - - [Comparators](./comparators.md) - - [Configurations](./configurations.md) - - [Data Types](./dataTypes.md) + - [Comments](comments.md) + - [Comparators](comparators.md) + - [Configuration](configuration.md) + - [Data Types](datatypes.md) - **Operators ▾** - [Table of Contents](#table-of-contents) - [Catalog](#catalog) - [About](#about) - [Documentation](#documentation) - - [Packages](./packages.md) - - [Sections](./sections.md) - - [Variables](./variables.md) -- [Python API](../pythonAPI.md) -- [Standard Library](../standardLibrary.md) + - [Packages](packages.md) + - [Sections](sections.md) + - [Variables](variables.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## Catalog @@ -1192,6 +1193,6 @@ prt myInteger --- -Last Updated: March 30th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--documents--operators) \ No newline at end of file diff --git a/docs/documents/packages.md b/docs/documents/packages.md index 3f3d326..e5b22e5 100644 --- a/docs/documents/packages.md +++ b/docs/documents/packages.md @@ -1,25 +1,26 @@ -# [x++](../../README.md) / [Documents](../documents.md) / Packages +# [x++](../README.md) / [Documents](../documents.md) / Packages ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - [Documents ▾](../documents.md) - [Table of Contents](../documents.md#table-of-contents) - [About](../documents.md#about) - [Documents ▾](../documents.md#documents) - - [Comments](./comments.md) - - [Comparators](./comparators.md) - - [Configurations](./configurations.md) - - [Data Types](./dataTypes.md) - - [Operators](./operators.md) + - [Comments](comments.md) + - [Comparators](comparators.md) + - [Configuration](configuration.md) + - [Data Types](datatypes.md) + - [Operators](operators.md) - **Packages ▾** - [Table of Contents](#table-of-contents) - [About](#about) - - [Sections](./sections.md) - - [Variables](./variables.md) -- [Python API](../pythonAPI.md) -- [Standard Library](../standardLibrary.md) + - [Sections](sections.md) + - [Variables](variables.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## About @@ -45,10 +46,10 @@ The same applies to importing files. To import a file from the x++ project, the path must contain the `.xpp` extension. The interpreter will then attempt to find the file from the current working directory. If one is not found, an error is thrown. -Currently, the [standard library](../standardLibrary.md) is built into the x++ interpreter. You can install more packages from GitHub. +Currently, the [standard library](../stdlib.md) is built into the x++ interpreter. You can install more packages from GitHub. --- -Last Updated: April 9th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--documents--packages) \ No newline at end of file diff --git a/docs/documents/sections.md b/docs/documents/sections.md index aca00aa..19739e4 100644 --- a/docs/documents/sections.md +++ b/docs/documents/sections.md @@ -1,25 +1,26 @@ -# [x++](../../README.md) / [Documents](../documents.md) / Sections +# [x++](../README.md) / [Documents](../documents.md) / Sections ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - [Documents ▾](../documents.md) - [Table of Contents](../documents.md#table-of-contents) - [About](../documents.md#about) - [Documents ▾](../documents.md#documents) - - [Comments](./comments.md) - - [Comparators](./comparators.md) - - [Configurations](./configurations.md) - - [Data Types](./dataTypes.md) - - [Operators](./operators.md) - - [Packages](./packages.md) + - [Comments](comments.md) + - [Comparators](comparators.md) + - [Configuration](configuration.md) + - [Data Types](datatypes.md) + - [Operators](operators.md) + - [Packages](packages.md) - **Sections ▾** - [Table of Contents](#table-of-contents) - [About](#about) - - [Variables](./variables.md) -- [Python API](../pythonAPI.md) -- [Standard Library](../standardLibrary.md) + - [Variables](variables.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## About @@ -56,6 +57,6 @@ prt output :: 3 --- -Last Updated: April 9th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--documents--sections) \ No newline at end of file diff --git a/docs/documents/variables.md b/docs/documents/variables.md index 3a0358c..22abc25 100644 --- a/docs/documents/variables.md +++ b/docs/documents/variables.md @@ -1,25 +1,26 @@ -# [x++](../../README.md) / [Documents](../documents.md) / Variables +# [x++](../README.md) / [Documents](../documents.md) / Variables ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - [Documents ▾](../documents.md) - [Table of Contents](../documents.md#table-of-contents) - [About](../documents.md#about) - [Documents ▾](../documents.md#documents) - - [Comments](./comments.md) - - [Comparators](./comparators.md) - - [Configurations](./configurations.md) - - [Data Types](./dataTypes.md) - - [Operators](./operators.md) - - [Packages](./packages.md) - - [Sections](./sections.md) + - [Comments](comments.md) + - [Comparators](comparators.md) + - [Configuration](configuration.md) + - [Data Types](datatypes.md) + - [Operators](operators.md) + - [Packages](packages.md) + - [Sections](sections.md) - **Variables ▾** - [Table of Contents](#table-of-contents) - [About](#about) -- [Python API](../pythonAPI.md) -- [Standard Library](../standardLibrary.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## About @@ -47,7 +48,7 @@ A file variable is defined by appending an at symbol (`@`) in front of the varia var @myInteger 5 ``` -A global variable is unable to be defined using x++ syntax. However, you can use [Python Integration](../pythonAPI.md) to do so. +A global variable is unable to be defined using x++ syntax. However, you can use [Python Integration](../python-api.md) to do so. Both local and file variables are automatically garbage collected, but they can also be manually deleted from RAM using the `rem` operator: @@ -58,6 +59,6 @@ rem myInteger @myInteger --- -Last Updated: April 9th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--documents--variables) \ No newline at end of file diff --git a/docs/pythonAPI.md b/docs/python-api.md similarity index 95% rename from docs/pythonAPI.md rename to docs/python-api.md index 724e566..c201a5d 100644 --- a/docs/pythonAPI.md +++ b/docs/python-api.md @@ -1,18 +1,18 @@ -# [x++](../README.md) / Python API +# [x++](README.md) / Python API ## Table of Contents -- [Home](../README.md) -- [Tutorials](./tutorials.md) -- [Documents](./documents.md) +- [Home](README.md) +- [Tutorials](tutorials.md) +- [Documents](documents.md) - **Python API ▾** - [Introduction](#introduction) - [Definitions](#definitions) - [Inline statements](#inline-statements) - [Python modules](#python-modules) - [Python inside .xconfig](#python-inside-xconfig) -- [Caffeine](./caffeine.md) -- [Standard Library](./standardLibrary.md) +- [Caffeine](caffeine.md) +- [Standard Library](stdlib.md) ## Introduction diff --git a/docs/standardLibrary.md b/docs/standardLibrary.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/standardLibrary/array.md b/docs/standardLibrary/array.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/standardLibrary/colors.md b/docs/standardLibrary/colors.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/standardLibrary/object.md b/docs/standardLibrary/object.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/standardLibrary/stdlib.md b/docs/standardLibrary/stdlib.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/stdlib.md b/docs/stdlib.md new file mode 100644 index 0000000..c5cc8a8 --- /dev/null +++ b/docs/stdlib.md @@ -0,0 +1,21 @@ +# [x++](README.md) / Standard Library + +## Table of Contents + +- [Home](README.md) +- [Tutorials](tutorials.md) +- [Documents](documents.md) +- [Python API](python-api.md) +- [Caffeine](caffeine.md) +- **Standard Library ▾** + - [Introduction](#introduction) + +## Introduction + +The x++ standard library is not currently finished, so no documentation is available yet. + +--- + +Last Updated: March 9th, 2024 by iiPython + +[↑ Go To Top](#x--standard-library) \ No newline at end of file diff --git a/docs/tutorials.md b/docs/tutorials.md index 7ccfd94..b38fd3c 100644 --- a/docs/tutorials.md +++ b/docs/tutorials.md @@ -1,36 +1,36 @@ -# [x++](../README.md) / Tutorials +# [x++](README.md) / Tutorials ## Table of Contents -- [Home](../README.md) +- [Home](README.md) - **Tutorials ▾** - [Table of Contents](#table-of-contents) - [About](#about) - [Tutorials ▾](#tutorials) - - [1. Hello, world!](./tutorials/1helloWorld.md) - - [2. User Input](./tutorials/2userInput.md) - - [3. Branches](./tutorials/3branches.md) - - [4. Calculator](./tutorials/4calculator.md) -- [Documents](./documents.md) -- [Python API](./pythonAPI.md) -- [Caffeine](./caffeine.md) -- [Standard Library](./standardLibrary.md) + - [1. Hello, world!](tutorials/hello-world.md) + - [2. User Input](tutorials/user-input.md) + - [3. Branching](tutorials/branching.md) + - [4. Calculator](tutorials/calculator.md) +- [Documents](documents.md) +- [Python API](python-api.md) +- [Caffeine](caffeine.md) +- [Standard Library](stdlib.md) ## About Welcome to the tutorials of the official x++ documentation. In this section, you will be learning all the basics within x++, including familiaring the syntax of x++ as well as creating your first x++ project! -If you are looking for information for a specific component of x++, check out the [documents](./documents.md) instead. +If you are looking for information for a specific component of x++, check out the [documents](documents.md) instead. ## Tutorials -- ### [1. Hello, world!](./tutorials/1helloWorld.md) -- ### [2. User Input](./tutorials/2userInput.md) -- ### [3. Branches](./tutorials/3branches.md) -- ### [4. Calculator](./tutorials/4calculator.md) +- [1. Hello, world!](tutorials/hello-world.md) +- [2. User Input](tutorials/user-input.md) +- [3. Branching](tutorials/branching.md) +- [4. Calculator](tutorials/calculator.md) --- -Last Updated: July 5th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--tutorials) \ No newline at end of file diff --git a/docs/tutorials/3branches.md b/docs/tutorials/branching.md similarity index 83% rename from docs/tutorials/3branches.md rename to docs/tutorials/branching.md index 8364e83..758fa3f 100644 --- a/docs/tutorials/3branches.md +++ b/docs/tutorials/branching.md @@ -1,22 +1,22 @@ -# [x++](../../README.md) / [Tutorials](../tutorials.md) / 3. Branches +# [x++](../README.md) / [Tutorials](../tutorials.md) / 3. Branches ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - - [Table of Contents](#table-of-contents) - - [About](#about) - - [Tutorials ▾](#tutorials) - - [1. Hello, world!](./1helloWorld.md) - - [2. User Input](./2userInput.md) - - **3. Branches ▾** + - [Table of Contents](../tutorials.md#table-of-contents) + - [About](../tutorials.md#about) + - [Tutorials ▾](../tutorials.md#tutorials) + - [1. Hello, world!](hello-world.md) + - [2. User Input](user-input.md) + - **3. Branching ▾** - [Table of Contents](#table-of-contents) - [Lesson](#lesson) - - [4. Calculator](./4calculator.md) + - [4. Calculator](calculator.md) - [Documents](../documents.md) -- [Python API](../standardLibrary.md) -- [Caffeine](./caffeine.md) -- [Standard Library](../pythonAPI.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## Lesson @@ -90,6 +90,6 @@ In the next lesson, you will be learning how to make a calculator using x++. --- -Last Updated: July 12th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--tutorials--3-branches) \ No newline at end of file diff --git a/docs/tutorials/4calculator.md b/docs/tutorials/calculator.md similarity index 87% rename from docs/tutorials/4calculator.md rename to docs/tutorials/calculator.md index b506380..2410091 100644 --- a/docs/tutorials/4calculator.md +++ b/docs/tutorials/calculator.md @@ -1,22 +1,22 @@ -# [x++](../../README.md) / [Tutorials](../tutorials.md) / 4. Calculator +# [x++](../README.md) / [Tutorials](../tutorials.md) / 4. Calculator ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - - [Table of Contents](#table-of-contents) - - [About](#about) - - [Tutorials ▾](#tutorials) - - [1. Hello, world!](./1helloWorld.md) - - [2. User Input](./2userInput.md) - - [3. Branches](./3branches.md) + - [Table of Contents](../tutorials.md#table-of-contents) + - [About](../tutorials.md#about) + - [Tutorials ▾](../tutorials.md#tutorials) + - [1. Hello, world!](hello-world.md) + - [2. User Input](user-input.md) + - [3. Branching](branching.md) - **4. Calculator ▾** - [Table of Contents](#table-of-contents) - [Lesson](#lesson) - [Documents](../documents.md) -- [Python API](../standardLibrary.md) -- [Caffeine](./caffeine.md) -- [Standard Library](../pythonAPI.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## Lesson @@ -127,6 +127,6 @@ Tada! You got a working calculator. How cool is that? --- -Last Updated: July 12th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--tutorials--4-calculator) \ No newline at end of file diff --git a/docs/tutorials/1helloWorld.md b/docs/tutorials/hello-world.md similarity index 86% rename from docs/tutorials/1helloWorld.md rename to docs/tutorials/hello-world.md index 7401ac0..74f820a 100644 --- a/docs/tutorials/1helloWorld.md +++ b/docs/tutorials/hello-world.md @@ -1,22 +1,22 @@ -# [x++](../../README.md) / [Tutorials](../tutorials.md) / 1. Hello, world! +# [x++](../README.md) / [Tutorials](../tutorials.md) / 1. Hello, world! ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - - [Table of Contents](#table-of-contents) - - [About](#about) - - [Tutorials ▾](#tutorials) + - [Table of Contents](../tutorials.md#table-of-contents) + - [About](../tutorials.md#about) + - [Tutorials ▾](../tutorials.md#tutorials) - **1. Hello, world! ▾** - [Table of Contents](#table-of-contents) - [Lesson](#lesson) - - [2. User Input](./2userInput.md) - - [3. Branches](./3branches.md) - - [4. Calculator](./4calculator.md) + - [2. User Input](user-input.md) + - [3. Branching](branching.md) + - [4. Calculator](calculator.md) - [Documents](../documents.md) -- [Python API](../standardLibrary.md) -- [Caffeine](./caffeine.md) -- [Standard Library](../pythonAPI.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## Lesson @@ -88,6 +88,6 @@ In the next lesson, you will learn how to get user input and manipulate strings --- -Last Updated: July 12th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--tutorials--1-hello-world) \ No newline at end of file diff --git a/docs/tutorials/2userInput.md b/docs/tutorials/user-input.md similarity index 83% rename from docs/tutorials/2userInput.md rename to docs/tutorials/user-input.md index a07e39d..2e589e2 100644 --- a/docs/tutorials/2userInput.md +++ b/docs/tutorials/user-input.md @@ -1,22 +1,22 @@ -# [x++](../../README.md) / [Tutorials](../tutorials.md) / 2. User Input +# [x++](../README.md) / [Tutorials](../tutorials.md) / 2. User Input ## Table of Contents -- [Home](../../README.md) +- [Home](../README.md) - [Tutorials](../tutorials.md) - - [Table of Contents](#table-of-contents) - - [About](#about) - - [Tutorials ▾](#tutorials) - - [1. Hello, world!](./1helloWorld.md) + - [Table of Contents](../tutorials.md#table-of-contents) + - [About](../tutorials.md#about) + - [Tutorials ▾](../tutorials.md#tutorials) + - [1. Hello, world!](./hello-world.md) - **2. User Input ▾** - [Table of Contents](#table-of-contents) - [Lesson](#lesson) - - [3. Branches](./3branches.md) - - [4. Calculator](./4calculator.md) + - [3. Branching](branching.md) + - [4. Calculator](calculator.md) - [Documents](../documents.md) -- [Python API](../standardLibrary.md) -- [Caffeine](./caffeine.md) -- [Standard Library](../pythonAPI.md) +- [Python API](../python-api.md) +- [Caffeine](../caffeine.md) +- [Standard Library](../stdlib.md) ## Lesson @@ -99,6 +99,6 @@ In the next lesson, you will learn how to make branches using the `if` operator. --- -Last Updated: July 12th, 2023 by iiPython +Last Updated: March 9th, 2024 by iiPython [↑ Go To Top](#x--tutorials--2-user-input) \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index f20ade8..fd6963a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,7 +46,7 @@ Homepage = "https://github.com/iiPythonx/xpp" Source = "https://github.com/iiPythonx/xpp" [tool.hatch.version] -path = "caffeine/__init__.py" +path = "src/xpp/__init__.py" [tool.hatch.build.targets.wheel] -packages = ["xpp", "caffeine"] +packages = ["src/xpp", "src/caffeine"] diff --git a/caffeine/__init__.py b/src/caffeine/__init__.py similarity index 100% rename from caffeine/__init__.py rename to src/caffeine/__init__.py diff --git a/caffeine/__main__.py b/src/caffeine/__main__.py similarity index 100% rename from caffeine/__main__.py rename to src/caffeine/__main__.py diff --git a/caffeine/modules/__init__.py b/src/caffeine/modules/__init__.py similarity index 100% rename from caffeine/modules/__init__.py rename to src/caffeine/modules/__init__.py diff --git a/caffeine/modules/exceptions.py b/src/caffeine/modules/exceptions.py similarity index 100% rename from caffeine/modules/exceptions.py rename to src/caffeine/modules/exceptions.py diff --git a/caffeine/modules/operators/__init__.py b/src/caffeine/modules/operators/__init__.py similarity index 100% rename from caffeine/modules/operators/__init__.py rename to src/caffeine/modules/operators/__init__.py diff --git a/caffeine/modules/operators/fileio.py b/src/caffeine/modules/operators/fileio.py similarity index 100% rename from caffeine/modules/operators/fileio.py rename to src/caffeine/modules/operators/fileio.py diff --git a/caffeine/modules/operators/internal.py b/src/caffeine/modules/operators/internal.py similarity index 100% rename from caffeine/modules/operators/internal.py rename to src/caffeine/modules/operators/internal.py diff --git a/caffeine/modules/operators/math.py b/src/caffeine/modules/operators/math.py similarity index 100% rename from caffeine/modules/operators/math.py rename to src/caffeine/modules/operators/math.py diff --git a/caffeine/modules/operators/objects.py b/src/caffeine/modules/operators/objects.py similarity index 100% rename from caffeine/modules/operators/objects.py rename to src/caffeine/modules/operators/objects.py diff --git a/caffeine/modules/operators/stdio.py b/src/caffeine/modules/operators/stdio.py similarity index 100% rename from caffeine/modules/operators/stdio.py rename to src/caffeine/modules/operators/stdio.py diff --git a/caffeine/modules/operators/strman.py b/src/caffeine/modules/operators/strman.py similarity index 100% rename from caffeine/modules/operators/strman.py rename to src/caffeine/modules/operators/strman.py diff --git a/caffeine/modules/optimize.py b/src/caffeine/modules/optimize.py similarity index 100% rename from caffeine/modules/optimize.py rename to src/caffeine/modules/optimize.py diff --git a/tests/__init__.py b/src/tests/__init__.py similarity index 100% rename from tests/__init__.py rename to src/tests/__init__.py diff --git a/tests/test_compare.py b/src/tests/test_compare.py similarity index 100% rename from tests/test_compare.py rename to src/tests/test_compare.py diff --git a/tests/test_file.py b/src/tests/test_file.py similarity index 100% rename from tests/test_file.py rename to src/tests/test_file.py diff --git a/tests/test_math.py b/src/tests/test_math.py similarity index 100% rename from tests/test_math.py rename to src/tests/test_math.py diff --git a/xpp/__init__.py b/src/xpp/__init__.py similarity index 100% rename from xpp/__init__.py rename to src/xpp/__init__.py diff --git a/xpp/__main__.py b/src/xpp/__main__.py similarity index 100% rename from xpp/__main__.py rename to src/xpp/__main__.py diff --git a/xpp/core/datastore.py b/src/xpp/core/datastore.py similarity index 100% rename from xpp/core/datastore.py rename to src/xpp/core/datastore.py diff --git a/xpp/core/interpreter.py b/src/xpp/core/interpreter.py similarity index 100% rename from xpp/core/interpreter.py rename to src/xpp/core/interpreter.py diff --git a/xpp/core/sections.py b/src/xpp/core/sections.py similarity index 100% rename from xpp/core/sections.py rename to src/xpp/core/sections.py diff --git a/xpp/core/tokenizer.py b/src/xpp/core/tokenizer.py similarity index 100% rename from xpp/core/tokenizer.py rename to src/xpp/core/tokenizer.py diff --git a/xpp/exceptions.py b/src/xpp/exceptions.py similarity index 100% rename from xpp/exceptions.py rename to src/xpp/exceptions.py diff --git a/xpp/extra/config.py b/src/xpp/extra/config.py similarity index 100% rename from xpp/extra/config.py rename to src/xpp/extra/config.py diff --git a/xpp/modules/ops/__init__.py b/src/xpp/modules/ops/__init__.py similarity index 100% rename from xpp/modules/ops/__init__.py rename to src/xpp/modules/ops/__init__.py diff --git a/xpp/modules/ops/shared.py b/src/xpp/modules/ops/shared.py similarity index 100% rename from xpp/modules/ops/shared.py rename to src/xpp/modules/ops/shared.py diff --git a/xpp/modules/ops/stdlib/fileio.py b/src/xpp/modules/ops/stdlib/fileio.py similarity index 100% rename from xpp/modules/ops/stdlib/fileio.py rename to src/xpp/modules/ops/stdlib/fileio.py diff --git a/xpp/modules/ops/stdlib/import_.py b/src/xpp/modules/ops/stdlib/import_.py similarity index 100% rename from xpp/modules/ops/stdlib/import_.py rename to src/xpp/modules/ops/stdlib/import_.py diff --git a/xpp/modules/ops/stdlib/internal.py b/src/xpp/modules/ops/stdlib/internal.py similarity index 100% rename from xpp/modules/ops/stdlib/internal.py rename to src/xpp/modules/ops/stdlib/internal.py diff --git a/xpp/modules/ops/stdlib/math.py b/src/xpp/modules/ops/stdlib/math.py similarity index 100% rename from xpp/modules/ops/stdlib/math.py rename to src/xpp/modules/ops/stdlib/math.py diff --git a/xpp/modules/ops/stdlib/objects.py b/src/xpp/modules/ops/stdlib/objects.py similarity index 100% rename from xpp/modules/ops/stdlib/objects.py rename to src/xpp/modules/ops/stdlib/objects.py diff --git a/xpp/modules/ops/stdlib/stdio.py b/src/xpp/modules/ops/stdlib/stdio.py similarity index 100% rename from xpp/modules/ops/stdlib/stdio.py rename to src/xpp/modules/ops/stdlib/stdio.py diff --git a/xpp/modules/ops/stdlib/strman.py b/src/xpp/modules/ops/stdlib/strman.py similarity index 100% rename from xpp/modules/ops/stdlib/strman.py rename to src/xpp/modules/ops/stdlib/strman.py diff --git a/xpp/modules/simpleeval.py b/src/xpp/modules/simpleeval.py similarity index 100% rename from xpp/modules/simpleeval.py rename to src/xpp/modules/simpleeval.py