| Name | xpp JSON |
| Version |
3.1.3
JSON |
| download |
| home_page | None |
| Summary | The x++ programming language. |
| upload_time | 2024-11-20 13:34:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.10 |
| license | MIT |
| keywords |
interpreter
language
parser
xpp
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align = "center">
<img src = "./assets/xpp.png" alt = "x++ logo" id = "logo">
<hr>
<p>an interpreted, minimalistic programming language</p>
<img alt = "License" src = "https://img.shields.io/github/license/iiPythonx/xpp?color=c3e7ff&style=flat-square">
<img alt = "Downloads" src = "https://img.shields.io/github/downloads/iiPythonx/xpp/total.svg?color=c3e7ff&style=flat-square">
<img alt = "Last commit" src = "https://img.shields.io/github/last-commit/iiPythonx/xpp?color=c3e7ff&style=flat-square">
<img alt = "Repo size" src = "https://img.shields.io/github/repo-size/iiPythonx/xpp?color=c3e7ff&style=flat-square">
<img alt = "Stars" src = "https://img.shields.io/github/stars/iiPythonx/xpp?color=c3e7ff&style=flat-square">
<hr>
</div>
<!-- ---- Introduction ---- -->
<h2 align = "center" id = "introduction">
Introduction
</h2>
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.
<!-- ---- TOC ---- -->
<h2 align = "center" id = "table-of-contents">
Table of Contents
</h2>
- **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](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)
<!-- ---- About ---- -->
<h2 align = "center" id = "about">
About
</h2>
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 ---- -->
<h2 align = "center" id = "getting-started">
Getting Started
</h2>
### 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:
```json
{
"main": "main.xpp"
}
```
> 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:
```
xpp .
```
Currently, you should see the terminal output:
```
"Hello, world!"
```
> You can also compile your xpp code into Python using [caffeine](https://xpp.iipython.dev/caffeine.html).
<!-- ---- FAQ ---- -->
<h2 align = "center">
Frequently Asked Questions
</h2>
### 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](https://xpp.iipython.dev/python-api.html).
<!-- ---- Contrib + resources ---- -->
<h2 align = "center">
Credits & Links
</h2>
### 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: March 9th, 2024 by iiPython
[↑ Go To Top](#introduction)
Raw data
{
"_id": null,
"home_page": null,
"name": "xpp",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": null,
"keywords": "interpreter, language, parser, xpp",
"author": null,
"author_email": "iiPython <ben@iipython.dev>",
"download_url": "https://files.pythonhosted.org/packages/42/9d/656b32a45f7b8488344a7eb7a0382ec05dd33efe91eb523bb556da760e75/xpp-3.1.3.tar.gz",
"platform": null,
"description": "<div align = \"center\">\n <img src = \"./assets/xpp.png\" alt = \"x++ logo\" id = \"logo\">\n <hr>\n <p>an interpreted, minimalistic programming language</p>\n <img alt = \"License\" src = \"https://img.shields.io/github/license/iiPythonx/xpp?color=c3e7ff&style=flat-square\">\n <img alt = \"Downloads\" src = \"https://img.shields.io/github/downloads/iiPythonx/xpp/total.svg?color=c3e7ff&style=flat-square\">\n <img alt = \"Last commit\" src = \"https://img.shields.io/github/last-commit/iiPythonx/xpp?color=c3e7ff&style=flat-square\">\n <img alt = \"Repo size\" src = \"https://img.shields.io/github/repo-size/iiPythonx/xpp?color=c3e7ff&style=flat-square\">\n <img alt = \"Stars\" src = \"https://img.shields.io/github/stars/iiPythonx/xpp?color=c3e7ff&style=flat-square\">\n <hr>\n</div>\n\n<!-- ---- Introduction ---- -->\n<h2 align = \"center\" id = \"introduction\">\n Introduction\n</h2>\n\nWelcome 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. \n\n<!-- ---- TOC ---- -->\n<h2 align = \"center\" id = \"table-of-contents\">\n Table of Contents\n</h2>\n\n- **Home \u25be**\n - [Introduction](#introduction)\n - [ToC](#table-of-contents)\n - [About](#about)\n - [Getting Started \u25be](#getting-started)\n - [Step 1: Installation](#step-1-installation)\n - [Step 2: Set-Up](#step-2-set-up)\n - [Step 3: Execution](#step-3-execution)\n - [Frequently Asked Questions](#frequently-asked-questions)\n - [Credits and Links \u25be](#credits--links)\n - [Contributors](#contributors)\n - [Resources](#resources)\n- [Tutorials](https://xpp.iipython.dev/tutorials.html)\n- [Documents](https://xpp.iipython.dev/documents.html)\n- [Python API](https://xpp.iipython.dev/python-api.html)\n- [Standard Library](https://xpp.iipython.dev/stdlib.html)\n\n<!-- ---- About ---- -->\n<h2 align = \"center\" id = \"about\">\n About\n</h2>\n\nx++ (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)).\n\nx++ contains features such as:\n- Automatic garbage collection\n- Scoped/file/global variables\n- Sectioning/function system\n- Mature python integration\n- Import/export/module system\n- Object-oriented programming through the use of files\n- ... much more!\n\n<!-- ---- Getting started ---- -->\n<h2 align = \"center\" id = \"getting-started\">\n Getting Started\n</h2>\n\n### Step 1: Installation\n\nFirst 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:\n\n```\npython3 -V\n```\n(on NT* platforms, replace `python3` with `py`)\n\nIt 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.\n\nNext, visit our [github repository](https://github.com/iiPythonx/xpp/) and download a clone of the repository by clicking on the green `Code \u25be` 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:\n\n```\ngit clone https://github.com/iiPythonx/xpp\n```\n\nTo install xpp system-wide, run the following:\n```\npip install .\n```\n\nYou will now have the `xpp` command available for use. \n\nIf 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.\n\n### Step 2: Set-Up\n\nOnce 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:\n\n```xpp\n:: Main\nprt \"Hello, world!\"\n```\n\nAny x++ files should always end in the `.xpp` extension.\n\nYou 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:\n\n```json\n{\n \"main\": \"main.xpp\"\n}\n```\n\n> You can learn more about setting up your project in the [tutorials](https://xpp.iipython.dev/tutorials.html).\n\n### Step 3: Execution\n\nAfter you are done writing your x++ code, you can execute your x++ project immediately by opening up a terminal and typing:\n\n```\nxpp .\n```\n\nCurrently, you should see the terminal output:\n\n```\n\"Hello, world!\"\n```\n> You can also compile your xpp code into Python using [caffeine](https://xpp.iipython.dev/caffeine.html).\n\n<!-- ---- FAQ ---- -->\n<h2 align = \"center\">\n Frequently Asked Questions\n</h2>\n\n### Q: Why is it called x++?\n\nThe 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`. \nStarting on March 6th, 2023, x2 was deprecated in favor of x++ as the language was beginning to undergo major changes.\n\n### Q: Can I use x++ for data management, game design, or simply for fun?\n\nMost 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).\n\n<!-- ---- Contrib + resources ---- -->\n<h2 align = \"center\">\n Credits & Links\n</h2>\n\n### Contributors\n\n- [iiPython](https://github.com/iiPythonx) - Developer, Documentation\n- [DmmD Gaming](https://github.com/DmmDGM) - Original Documentation, Ideas, & Standard Library\n\n### Resources\n\n- [Github Repository](https://github.com/iiPythonx/xpp)\n- [Visual Studio Code x++ Extension](https://marketplace.visualstudio.com/items?itemName=iiPython.xplusplus)\n\n---\n\nLast Updated: March 9th, 2024 by iiPython\n\n[\u2191 Go To Top](#introduction)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The x++ programming language.",
"version": "3.1.3",
"project_urls": {
"Bug Reports": "https://github.com/iiPythonx/xpp/issues",
"Homepage": "https://github.com/iiPythonx/xpp",
"Source": "https://github.com/iiPythonx/xpp"
},
"split_keywords": [
"interpreter",
" language",
" parser",
" xpp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc63bf91741a1bc5b5f68cfeebb678271cac2b173ffa899920df2ac20c538b62",
"md5": "7c5097e5182da4c5b77289a02f09de86",
"sha256": "b08fee936b1234867b85896bcd173a6a0122bd3ff591deeb2684dee0a2fab35c"
},
"downloads": -1,
"filename": "xpp-3.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c5097e5182da4c5b77289a02f09de86",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.10",
"size": 34468,
"upload_time": "2024-11-20T13:34:51",
"upload_time_iso_8601": "2024-11-20T13:34:51.602064Z",
"url": "https://files.pythonhosted.org/packages/cc/63/bf91741a1bc5b5f68cfeebb678271cac2b173ffa899920df2ac20c538b62/xpp-3.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "429d656b32a45f7b8488344a7eb7a0382ec05dd33efe91eb523bb556da760e75",
"md5": "96eb54bd2fccbe43912cb13f5755debd",
"sha256": "6ec46b293242ff9b4d8a4c1dee1b19495f529769c2d1802996a6638750a039ea"
},
"downloads": -1,
"filename": "xpp-3.1.3.tar.gz",
"has_sig": false,
"md5_digest": "96eb54bd2fccbe43912cb13f5755debd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 45232,
"upload_time": "2024-11-20T13:34:52",
"upload_time_iso_8601": "2024-11-20T13:34:52.842438Z",
"url": "https://files.pythonhosted.org/packages/42/9d/656b32a45f7b8488344a7eb7a0382ec05dd33efe91eb523bb556da760e75/xpp-3.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 13:34:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iiPythonx",
"github_project": "xpp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "xpp"
}
