You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-11-06 08:49:29 +02:00
Создание MD файлов документации
This commit is contained in:
Vitaly the Alpaca
committed by
Vitaly the Alpaca (bot)
Vitaly the Alpaca (bot)
parent
9c2d012d41
commit
09822c04ec
@@ -1,42 +1,42 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Working with CLI app
|
||||
|
||||
**OInt CLI** - приложение for commandsой withтроtoи, toоторое позinоляет иwithпользоinать methodы Отtoрытого паtoета интеграций незаinиwithимо от 1С и OneScript. For его work требуетwithя **.Net Framework 4.8** or withопоwithтаinимый **Mono Runtime** (при иwithпользоinании deb и rpm паtoетоin уwithтаtoinлиinаетwithя аinтоматичеwithtoи)
|
||||
|
||||
## First запуwithto
|
||||
|
||||
For of start work необходимо inызinать commandsу `oint` from commandsной withтроtoи/термиtoла. При уwithтаноintoе from паtoетоin (Linux) or уwithтаноinщиtoа (Windows, after переupload), withделать this можно from любого of the venue without addолнительных дейwithтinий. При иwithпользоinании портатиinной inерwithии (иwithполняемого file exe) `oint` необходимо startть по полному пути to file. In Linux-диwithтрибутиinах, таtoже, предinарительно нужно will пропиwithать `chmod +x <path to file>/oint`
|
||||
|
||||
Запуwithto портатиinной inерwithии in RHEL/Fedora/CentOS (диwithтрибутиinы, иwithпользующие rpm-паtoеты) оwithущеwithтinляетwithя commandsой <br/>`mono <path to file>/oint "$@"`
|
||||
|
||||
|
||||
|
||||
## Help
|
||||
|
||||
Towithле start приложения, inы уinидите toчальную page, где еwithть перечень available библиотеto. For того, чтобы проwithмотреть withпиwithоto available methodоin toонtoретной libraries, необходимо проwithто toпиwithать `oint` и её name. Nапример `oint telegram`. Аtoлогично можно узtoть подробноwithти о toонtoретном methodе - необходимо inызinать commandsу `oint <библиотеtoа> <method>`, toпример `oint telegram SendTextMessage`
|
||||
|
||||
>**Inажно:** Andмеto библиотеto чуinwithтinительны to региwithтру и пишутwithя withтрочными буtoinами. Andмеto methodоin to региwithтру не чуinwithтinительны
|
||||
|
||||
|
||||
|
||||
## Andwithпользоinание methodоin
|
||||
Kаto и большинwithтinо других программ, toцеленных to иwithпользоinание in bat/sh withtoриптах, toаждое отдельное дейwithтinие Oint CLI inызыinаетwithя полной withтроtoой inызоinа withледующего inида:
|
||||
|
||||
```powershell
|
||||
oint <библиотеtoа> <method> --парам1 "Value" --парам2 "Value"...
|
||||
```
|
||||
|
||||
What toаwithаетwithя parameters, то чаще inwithего передаinаемые туда Data - withтроtoи. Это может be text, пути to fileм, URL и пр. Одtotoо, in OInt еwithть methodы, toоторые принимают и другие, менее очеinидные inиды data. Это могут be:
|
||||
|
||||
+ Даты - передаютwithя toаto withтроtoи формата ISO 8601
|
||||
+ Arrayы - передаютwithя toаto withтроtoи inида `"['Val1','Val2','Val3']"`
|
||||
+ JSON - передаетwithя toаto path to file
|
||||
|
||||
Towithле inыполнения запрашиinаемого дейwithтinия, программа inыinодит результат и заinершает работу. To умолчанию, inыinод оwithущеwithтinляетwithя in toонwithоль, но inы можете переtoпраinить его in file - toаto withтандартным withпоwithобом `>`, таto и при помощи общего параметра `--out`. Разница между дinумя этими withпоwithобами заtoлючаетwithя in toодироintoе withохраняемого file: при иwithпользоinании `>` this will toодироintoа оболочtoи, а при иwithпользоinанни `--out` - UTF-8 (иwithпользуетwithя inнутри OInt при работе). Таtoже иwithпользоinание `--out` обязательно for methodоin, inозinращающих дinоичные Data in отinете (like withtoачиinания file from Google Drive, toпример)
|
||||
|
||||
|
||||
|
||||
Inwithю дальнейшую информацию, toоторая может поtoдобитьwithя inам for work, inы withможете toйти in других разделах данной доtoументации, а таtoже inо inwithтроенной withпраintoе OInt CLI
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Working with CLI app
|
||||
|
||||
**OInt CLI** - приложение for commandsой withтроtoи, toоторое позinоляет иwithпользоinать methodы Отtoрытого паtoета интеграций незаinиwithимо от 1С и OneScript. For его work требуетwithя **.Net Framework 4.8** or withопоwithтаinимый **Mono Runtime** (при иwithпользоinании deb и rpm паtoетоin уwithтаtoinлиinаетwithя аinтоматичеwithtoи)
|
||||
|
||||
## First запуwithto
|
||||
|
||||
For of start work необходимо inызinать commandsу `oint` from commandsной withтроtoи/термиtoла. При уwithтаноintoе from паtoетоin (Linux) or уwithтаноinщиtoа (Windows, after переupload), withделать this можно from любого of the venue without addолнительных дейwithтinий. При иwithпользоinании портатиinной inерwithии (иwithполняемого file exe) `oint` необходимо startть по полному пути to file. In Linux-диwithтрибутиinах, таtoже, предinарительно нужно will пропиwithать `chmod +x <path to file>/oint`
|
||||
|
||||
Запуwithto портатиinной inерwithии in RHEL/Fedora/CentOS (диwithтрибутиinы, иwithпользующие rpm-паtoеты) оwithущеwithтinляетwithя commandsой <br/>`mono <path to file>/oint "$@"`
|
||||
|
||||
|
||||
|
||||
## Help
|
||||
|
||||
Towithле start приложения, inы уinидите toчальную page, где еwithть перечень available библиотеto. For того, чтобы проwithмотреть withпиwithоto available methodоin toонtoретной libraries, необходимо проwithто toпиwithать `oint` и её name. Nапример `oint telegram`. Аtoлогично можно узtoть подробноwithти о toонtoретном methodе - необходимо inызinать commandsу `oint <библиотеtoа> <method>`, toпример `oint telegram SendTextMessage`
|
||||
|
||||
>**Inажно:** Andмеto библиотеto чуinwithтinительны to региwithтру и пишутwithя withтрочными буtoinами. Andмеto methodоin to региwithтру не чуinwithтinительны
|
||||
|
||||
|
||||
|
||||
## Andwithпользоinание methodоin
|
||||
Kаto и большинwithтinо других программ, toцеленных to иwithпользоinание in bat/sh withtoриптах, toаждое отдельное дейwithтinие Oint CLI inызыinаетwithя полной withтроtoой inызоinа withледующего inида:
|
||||
|
||||
```powershell
|
||||
oint <библиотеtoа> <method> --парам1 "Value" --парам2 "Value"...
|
||||
```
|
||||
|
||||
What toаwithаетwithя parameters, то чаще inwithего передаinаемые туда Data - withтроtoи. Это может be text, пути to fileм, URL и пр. Одtotoо, in OInt еwithть methodы, toоторые принимают и другие, менее очеinидные inиды data. Это могут be:
|
||||
|
||||
+ Даты - передаютwithя toаto withтроtoи формата ISO 8601
|
||||
+ Arrayы - передаютwithя toаto withтроtoи inида `"['Val1','Val2','Val3']"`
|
||||
+ JSON - передаетwithя toаto path to file
|
||||
|
||||
Towithле inыполнения запрашиinаемого дейwithтinия, программа inыinодит результат и заinершает работу. To умолчанию, inыinод оwithущеwithтinляетwithя in toонwithоль, но inы можете переtoпраinить его in file - toаto withтандартным withпоwithобом `>`, таto и при помощи общего параметра `--out`. Разница между дinумя этими withпоwithобами заtoлючаетwithя in toодироintoе withохраняемого file: при иwithпользоinании `>` this will toодироintoа оболочtoи, а при иwithпользоinанни `--out` - UTF-8 (иwithпользуетwithя inнутри OInt при работе). Таtoже иwithпользоinание `--out` обязательно for methodоin, inозinращающих дinоичные Data in отinете (like withtoачиinания file from Google Drive, toпример)
|
||||
|
||||
|
||||
|
||||
Inwithю дальнейшую информацию, toоторая может поtoдобитьwithя inам for work, inы withможете toйти in других разделах данной доtoументации, а таtoже inо inwithтроенной withпраintoе OInt CLI
|
||||
|
||||
@@ -1,53 +1,53 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# About releases variants
|
||||
|
||||
The Open Integration Package is a project with three development paths: 1C, OneScript, and CLI. The main version is 1C, which is then automatically transformed into a package for OneScript, and from there into a CLI application. Each of these paths has its own distribution options – there are 8 in total: 3 for 1C, 4 for CLI, and 1 for OneScript. Descriptions of each of these are provided below
|
||||
|
||||
>To the latest release: [Click!](https://github.com/Bayselonarrend/OpenIntegrations/releases/latest)
|
||||
|
||||
## 1С:Enterprise
|
||||
These release options are various forms of distribution for the extension for the 1C:Enterprise platform
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/1.png').default} width="86" align="left"/>
|
||||
**OpenIntegrations_x.x.x.cfe** - the standard distribution option for the 1C configuration extension. To start working, it is sufficient to load it into the list of extensions for your specific configuration. Development is carried out in compatibility mode with 1C 8.3.9.
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/2.png').default} width="86" align="left"/>
|
||||
**XML.zip** - this is a zip archive that contains the files of the standard 1C extension export "to files". Similar to the CFE option, the unpacked archive can be used to load the extension through the Configuration Extensions panel in a specific project
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/3.png').default} width="86" align="left"/>
|
||||
**EDT.zip** - this is a zip archive that contains the files of the EDT extension project. This distribution option is intended for quickly starting work with the Open Integration Package in cases where the development of the main configuration is carried out using 1C Enterprise Development Tools
|
||||
|
||||
<br/>
|
||||
|
||||
## CLI
|
||||
these release options are various forms of distribution for OInt CLI – a cross-platform terminal/command line application that implements the full functionality of the OpenIntegrations library without being tied to the 1C/OS technology stack. The system requirements for OInt are the system requirements for OneScript: **.Net Framework 4.8 (Windows)** or **a comparable version of Mono (Linux)**
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'20px'}} src={require('./img/5.png').default} width="86" align="left"/>
|
||||
**oint.exe** - an executable file that, despite its Windows-oriented extension, is cross-platform. It requires .Net Framework 4.8 or a compatible version of Mono to run. In Windows and Debian-based distributions, this application is launched simply through the command line/terminal, while in RHEL-based distributions, it is launched through ```mono oint.exe "$@"```
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'20px'}} src={require('./img/6.png').default} width="86" align="left"/>
|
||||
**oint_x.x.x_installer.exe** - this is a Windows installer. It is the recommended installation method for Windows OS, as it automatically creates the program directory and sets the PATH (after restarting the computer). This allows the application to be launched from any location by simply typing oint in the command line
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/7.png').default} width="86" align="left"/>
|
||||
**oint_x.x.x_all.deb** - this is a DEB package designed for installing OInt on Debian/Ubuntu distributions. When using it, Mono dependencies are installed automatically, so no additional actions are required to start working
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'16px'}} src={require('./img/8.png').default} width="86" align="left"/>
|
||||
**oint-x.x.x-1.el7.x86_64.rpm** - this is an RPM package designed for installing OInt on RHEL/Fedora/CentOS distributions. When using it, Mono dependencies are installed automatically, so no additional actions are required to start working. Also, there is no need to run it through mono, as with the exe.
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
## OneScript
|
||||
These release options are intended for use in OneScript projects
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'16px'}} src={require('./img/4.png').default} width="86" align="left"/>
|
||||
**oint-x.x.x.ospx** - this is an OSPX package intended for installation via the OPM package manager. You can use it for offline installation using the command
|
||||
``` opm install -f "./OInt-x.x.x.ospx" ```.
|
||||
But it is much easier to install OInt directly from the package hub. You don't need to download any files for this, just execute the command ``` opm install oint ```
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# About releases variants
|
||||
|
||||
The Open Integration Package is a project with three development paths: 1C, OneScript, and CLI. The main version is 1C, which is then automatically transformed into a package for OneScript, and from there into a CLI application. Each of these paths has its own distribution options – there are 8 in total: 3 for 1C, 4 for CLI, and 1 for OneScript. Descriptions of each of these are provided below
|
||||
|
||||
>To the latest release: [Click!](https://github.com/Bayselonarrend/OpenIntegrations/releases/latest)
|
||||
|
||||
## 1С:Enterprise
|
||||
These release options are various forms of distribution for the extension for the 1C:Enterprise platform
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/1.png').default} width="86" align="left"/>
|
||||
**OpenIntegrations_x.x.x.cfe** - the standard distribution option for the 1C configuration extension. To start working, it is sufficient to load it into the list of extensions for your specific configuration. Development is carried out in compatibility mode with 1C 8.3.9.
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/2.png').default} width="86" align="left"/>
|
||||
**XML.zip** - this is a zip archive that contains the files of the standard 1C extension export "to files". Similar to the CFE option, the unpacked archive can be used to load the extension through the Configuration Extensions panel in a specific project
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/3.png').default} width="86" align="left"/>
|
||||
**EDT.zip** - this is a zip archive that contains the files of the EDT extension project. This distribution option is intended for quickly starting work with the Open Integration Package in cases where the development of the main configuration is carried out using 1C Enterprise Development Tools
|
||||
|
||||
<br/>
|
||||
|
||||
## CLI
|
||||
these release options are various forms of distribution for OInt CLI – a cross-platform terminal/command line application that implements the full functionality of the OpenIntegrations library without being tied to the 1C/OS technology stack. The system requirements for OInt are the system requirements for OneScript: **.Net Framework 4.8 (Windows)** or **a comparable version of Mono (Linux)**
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'20px'}} src={require('./img/5.png').default} width="86" align="left"/>
|
||||
**oint.exe** - an executable file that, despite its Windows-oriented extension, is cross-platform. It requires .Net Framework 4.8 or a compatible version of Mono to run. In Windows and Debian-based distributions, this application is launched simply through the command line/terminal, while in RHEL-based distributions, it is launched through ```mono oint.exe "$@"```
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'20px'}} src={require('./img/6.png').default} width="86" align="left"/>
|
||||
**oint_x.x.x_installer.exe** - this is a Windows installer. It is the recommended installation method for Windows OS, as it automatically creates the program directory and sets the PATH (after restarting the computer). This allows the application to be launched from any location by simply typing oint in the command line
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'6px'}} src={require('./img/7.png').default} width="86" align="left"/>
|
||||
**oint_x.x.x_all.deb** - this is a DEB package designed for installing OInt on Debian/Ubuntu distributions. When using it, Mono dependencies are installed automatically, so no additional actions are required to start working
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'16px'}} src={require('./img/8.png').default} width="86" align="left"/>
|
||||
**oint-x.x.x-1.el7.x86_64.rpm** - this is an RPM package designed for installing OInt on RHEL/Fedora/CentOS distributions. When using it, Mono dependencies are installed automatically, so no additional actions are required to start working. Also, there is no need to run it through mono, as with the exe.
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
## OneScript
|
||||
These release options are intended for use in OneScript projects
|
||||
|
||||
<img style={{paddingRight:'20px',marginTop:'16px'}} src={require('./img/4.png').default} width="86" align="left"/>
|
||||
**oint-x.x.x.ospx** - this is an OSPX package intended for installation via the OPM package manager. You can use it for offline installation using the command
|
||||
``` opm install -f "./OInt-x.x.x.ospx" ```.
|
||||
But it is much easier to install OInt directly from the package hub. You don't need to download any files for this, just execute the command ``` opm install oint ```
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -1,44 +1,44 @@
|
||||
---
|
||||
id: Start
|
||||
sidebar_class_name: NachaloRaboty
|
||||
---
|
||||
|
||||
# Welcome!
|
||||
|
||||
|
||||
|
||||
**Open Integrations Package** - is a set of tools for integration with some popular APIs via CLI, 1C, or OneScript. It consists of common modules, each responsible for its own API, as well as several utility modules that are common to all.
|
||||
|
||||
The implemented methods perform specific tasks (such as *SendMessage()* or *CreatePost()*), allowing them to be used without delving into the implementation details. However, the code is highly decomposed – authorization methods, data retrieval, etc., are separated into individual functions where possible. This makes it easy to add new methods, even if they are not yet implemented in the library at the current time.
|
||||
|
||||
<br/>
|
||||
|
||||
## Getting started
|
||||
|
||||
The library releases come in five variants:
|
||||
|
||||
- As a CLI application for Windows and Linux (exe, rpm, deb)
|
||||
- As XML extension files for loading via the configurator
|
||||
- As an EDT extension project
|
||||
- As a standalone extension file in cfe format
|
||||
- As a OneScript extension package in ospx format
|
||||
|
||||
Regardless of the chosen installation method, the files must be obtained from the [Release](https://github.com/Bayselonarrend/OpenIntegrations/releases) section, as the repository files may contain intermediate data and functions that are still in development.
|
||||
|
||||
For more details about each release variant, see the section [About Release Variants](/docs/Start/Release-variants)
|
||||
|
||||
<br/>
|
||||
|
||||
## Structure of modules
|
||||
|
||||
The project's common modules come in two types:
|
||||
|
||||
- Service
|
||||
- OPI_Tools
|
||||
- OPI_Cryptography
|
||||
- Modules for direct interaction with APIs
|
||||
- OPI_Telegram, OPI_VK...
|
||||
|
||||
:::warning
|
||||
It is not recommended to use the methods of utility modules in other parts of your configuration (if you plan to update to new versions in the future). To maintain backward compatibility, the number/purpose of parameters and the return types for API interaction methods do not change, but this does not apply to utility modules, which can be modified in any way for optimization and adaptation to new requirements. If you need functionality from the utility modules, it is recommended to copy it separately.
|
||||
:::
|
||||
---
|
||||
id: Start
|
||||
sidebar_class_name: NachaloRaboty
|
||||
---
|
||||
|
||||
# Welcome!
|
||||
|
||||
|
||||
|
||||
**Open Integrations Package** - is a set of tools for integration with some popular APIs via CLI, 1C, or OneScript. It consists of common modules, each responsible for its own API, as well as several utility modules that are common to all.
|
||||
|
||||
The implemented methods perform specific tasks (such as *SendMessage()* or *CreatePost()*), allowing them to be used without delving into the implementation details. However, the code is highly decomposed – authorization methods, data retrieval, etc., are separated into individual functions where possible. This makes it easy to add new methods, even if they are not yet implemented in the library at the current time.
|
||||
|
||||
<br/>
|
||||
|
||||
## Getting started
|
||||
|
||||
The library releases come in five variants:
|
||||
|
||||
- As a CLI application for Windows and Linux (exe, rpm, deb)
|
||||
- As XML extension files for loading via the configurator
|
||||
- As an EDT extension project
|
||||
- As a standalone extension file in cfe format
|
||||
- As a OneScript extension package in ospx format
|
||||
|
||||
Regardless of the chosen installation method, the files must be obtained from the [Release](https://github.com/Bayselonarrend/OpenIntegrations/releases) section, as the repository files may contain intermediate data and functions that are still in development.
|
||||
|
||||
For more details about each release variant, see the section [About Release Variants](/docs/Start/Release-variants)
|
||||
|
||||
<br/>
|
||||
|
||||
## Structure of modules
|
||||
|
||||
The project's common modules come in two types:
|
||||
|
||||
- Service
|
||||
- OPI_Tools
|
||||
- OPI_Cryptography
|
||||
- Modules for direct interaction with APIs
|
||||
- OPI_Telegram, OPI_VK...
|
||||
|
||||
:::warning
|
||||
It is not recommended to use the methods of utility modules in other parts of your configuration (if you plan to update to new versions in the future). To maintain backward compatibility, the number/purpose of parameters and the return types for API interaction methods do not change, but this does not apply to utility modules, which can be modified in any way for optimization and adaptation to new requirements. If you need functionality from the utility modules, it is recommended to copy it separately.
|
||||
:::
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"label": "Getting started",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "Start"
|
||||
}
|
||||
}
|
||||
{
|
||||
"label": "Getting started",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "doc",
|
||||
"id": "Start"
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user