<!-- markdownlint-configure-file {
"MD033": false,
"MD041": false
} -->
# tko
O TKO é um sistema de testes para programação competitiva. Ele é capaz de rodar testes em várias linguagens de programação e em vários formatos de testes. Ele está integrado com os repositórios de atividades das disciplinas de programação da UFC de Quixadá permitindo baixar as atividades e rodar os testes.
- [FUP - Fundamentos de Programação](https://github.com/qxcodefup/arcade)
- [ED - Estrutura de Dados](https://github.com/qxcodeed/arcade)
- [POO - Programação Orientada a Objetos](https://github.com/qxcodepoo/arcade)
## Instalação
### Windows
- Vamos instalar o WSL. Abra o powershell e digite
```bash
wsl --install
```
- Aceite as opções e espere terminar a instalação. Reinicie o computador.
- Agora vamos configurar o vscode pra funcionar com o WSL.
- Instale o vscode normalmente pelo windows.
- Abra o vscode pelo windows e instale a extensão WSL com 30 M de downloads
- No lançador de aplicativos do windows, procure por "WSL" e abra o terminal do ubuntu
- Digite o comando abaixo em qualquer pasta para configurar vscode no ubuntu
```bash
code .
```
- Esse comando irá instalar os componenetes necessários para abrir o vscode pelo wsl.
- Agora, sempre que quiser abrir um repositório, abra o terminal do ubuntu, navegue até a pasta do repositório e execute o comando `code .`
- Vamos seguir para falta o tko e os compiladores no seu novo linux ubuntu no wsl.
### Instalando o Python, pipx e o tko e ferramentas básicas de desenvolvimento
#### Windows com WSL e Ubuntu
```bash
sudo apt update && sudo apt install -y build-essential pipx && pipx install tko
```
#### Arch Linux e Derivados
```bash
sudo pacman -S --noconfirm base-devel python-pipx && pipx install tko
```
#### Codespaces
```bash
sudo apt update && sudo apt install -y python3-pip && pip install pipx && pipx install tko
```
### Adicionando o tko no path
```bash
# adicione o path do pip para o bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
```
## Atualizando seu tko
Para atualizar o tko para versão mais recente, basta executar o comando:
```bash
pipx upgrade tko # codespace, arch, ubuntu e wsl
```
## Instalando os compiladores
- Você pode utilizar qualquer outra linguagens que quiser, basta instalar o compilador correspondente e definir o comando de compilação e execução correspondentes.
### WSL e Ubuntu
```bash
# Java
sudo apt install openjdk-11-jdk
# Typescript
sudo apt install nodejs npm
npm install --save-dev @types/node
npm install typescript esbuild readline-sync
```
### Arch
```bash
# Java
sudo pacman -S jdk-openjdk
# Typescript
sudo pacman -S nodejs npm
npm install --save-dev @types/node
npm install typescript esbuild readline-sync
```
## Para interagir com os repositórios, navegar, baixar, testar
Os `[]` e `<>` indicam onde devem ser colocados os parâmetros. Os `|` indicam opções.
```bash
# primeiro crie um repositório local na pasta local
tko init --remote [poo | fup | ed]
# exemplo tko init --remote fup
# agora abra o repositório para interagir com ele
tko open <pasta_do_repositório>
# exemplo: tko open fup
```
## Programando em uma linguagem diferente de C, C++, Java, Python e Typescript
- Qual for escolher a linguagem que deseja utilizar, escolha `yaml`. Na pasta de cada atividade será criado um arquivo de rascunho chamado `draft.yaml` com os seguintes campos:
```yaml
build:
run:
```
- Preencha os campos `build` e `run` com os comandos de compilação e execução da sua linguagem. Exemplo, em c++ para um arquivo fonte chamado solver.cpp, o `draft.yaml` ficaria assim:
```yaml
build: g++ -Wall solver.cpp -o solver.out
run: ./solver.out
```
Adapte para os comandos da sua linguagem e o nome dos arquivos da pasta.
## Criando os testes
### Descompactando os testes
Se preferir trabalhar com o modelo de testes em arquivos separados, você pode descompactar o arquivo `cases.tio` para uma pasta com os arquivos de entrada e saída. Será gerado um arquivo `.in` e um `.sol` para cada teste.
```bash
$ mkdir pasta
$ tko build pasta cases.tio
$ ls pasta
00.in 00.sol 01.in 01.sol 02.in 02.sol 03.in 03.sol 04.in 04.sol
```
Para rodar a partir da pasta com os testes descompactados, basta passar o nome da pasta como parâmetro.
```bash
tko run Solver.java pasta
```
Se quiser utilizar um nome padrão diferente para leitura ou escrita das pastas, veja a seção de [Convertendo entre formatos](#convertendo-entre-formatos).
## Convertendo entre formatos
- Gerando um `t.vpl`
- `tko build t.vpl testes.tio`
- Gerando um `t.tio` a partir do `Readme.md`e de um `extra.tio`.
- `tko build t.tio Readme.md extra.tio`
- Para extrair os testes para uma pasta com um arquivo para entrada e outro para saída, crie uma pasta vazia e passe para o primeiro parâmetro do `tko build`.
```bash
$ ls
cases.tio draft.c Readme.md
$ mkdir pasta
$ tko build pasta cases.tio
$ ls pasta/
00.in 02.sol 05.in 07.sol 10.in 12.sol 15.in 17.sol 20.in 22.sol
00.sol 03.in 05.sol 08.in 10.sol 13.in 15.sol 18.in 20.sol 23.in
01.in 03.sol 06.in 08.sol 11.in 13.sol 16.in 18.sol 21.in 23.sol
01.sol 04.in 06.sol 09.in 11.sol 14.in 16.sol 19.in 21.sol
02.in 04.sol 07.in 09.sol 12.in 14.sol 17.in 19.sol 22.in
```
- Você pode definir o padrão de nome dos arquivos gerados com `-p "@ @"`, sendo @ o wildcard que representa a numeração dos arquivo.
- Vamos refazer o comando acima, mas colocando "-p in.@ out.@"
```bash
$ tko build pasta/ cases.tio -p "in.@ out.@"
$ ls pasta/
in.00 in.05 in.10 in.15 in.20 out.01 out.06 out.11 out.16 out.21
in.01 in.06 in.11 in.16 in.21 out.02 out.07 out.12 out.17 out.22
in.02 in.07 in.12 in.17 in.22 out.03 out.08 out.13 out.18 out.23
in.03 in.08 in.13 in.18 in.23 out.04 out.09 out.14 out.19
in.04 in.09 in.14 in.19 out.00 out.05 out.10 out.15 out.20
```
- O `pattern` é útil para converter os formatos de Maratona, que vem em múltiplos arquivos para o `.tio`. Basta fazer o `match` do modelo que eles utilizarem.
- `-p "@.in @.out"`
- `-p "in@ out@"`
- entre outros.
Raw data
{
"_id": null,
"home_page": "https://github.com/senapk/tko",
"name": "tko",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "programming, learning",
"author": "David Sena Oliveira",
"author_email": "sena@ufc.br",
"download_url": "https://files.pythonhosted.org/packages/3c/11/5ef69e00b543de6f37650a9a26d7712033b10dcf5261337e5cb6268b70c8/tko-2.5.1.tar.gz",
"platform": null,
"description": "<!-- markdownlint-configure-file {\n \"MD033\": false,\n \"MD041\": false\n} -->\n\n# tko\n\nO TKO \u00e9 um sistema de testes para programa\u00e7\u00e3o competitiva. Ele \u00e9 capaz de rodar testes em v\u00e1rias linguagens de programa\u00e7\u00e3o e em v\u00e1rios formatos de testes. Ele est\u00e1 integrado com os reposit\u00f3rios de atividades das disciplinas de programa\u00e7\u00e3o da UFC de Quixad\u00e1 permitindo baixar as atividades e rodar os testes.\n\n- [FUP - Fundamentos de Programa\u00e7\u00e3o](https://github.com/qxcodefup/arcade)\n- [ED - Estrutura de Dados](https://github.com/qxcodeed/arcade)\n- [POO - Programa\u00e7\u00e3o Orientada a Objetos](https://github.com/qxcodepoo/arcade)\n\n## Instala\u00e7\u00e3o\n\n### Windows\n\n- Vamos instalar o WSL. Abra o powershell e digite\n\n```bash\nwsl --install\n```\n\n- Aceite as op\u00e7\u00f5es e espere terminar a instala\u00e7\u00e3o. Reinicie o computador.\n- Agora vamos configurar o vscode pra funcionar com o WSL.\n- Instale o vscode normalmente pelo windows.\n- Abra o vscode pelo windows e instale a extens\u00e3o WSL com 30 M de downloads\n- No lan\u00e7ador de aplicativos do windows, procure por \"WSL\" e abra o terminal do ubuntu\n- Digite o comando abaixo em qualquer pasta para configurar vscode no ubuntu\n\n```bash\ncode .\n```\n\n- Esse comando ir\u00e1 instalar os componenetes necess\u00e1rios para abrir o vscode pelo wsl.\n- Agora, sempre que quiser abrir um reposit\u00f3rio, abra o terminal do ubuntu, navegue at\u00e9 a pasta do reposit\u00f3rio e execute o comando `code .`\n- Vamos seguir para falta o tko e os compiladores no seu novo linux ubuntu no wsl.\n\n### Instalando o Python, pipx e o tko e ferramentas b\u00e1sicas de desenvolvimento\n\n#### Windows com WSL e Ubuntu\n\n```bash\nsudo apt update && sudo apt install -y build-essential pipx && pipx install tko\n```\n\n#### Arch Linux e Derivados\n\n```bash\nsudo pacman -S --noconfirm base-devel python-pipx && pipx install tko\n```\n\n#### Codespaces\n\n```bash\nsudo apt update && sudo apt install -y python3-pip && pip install pipx && pipx install tko\n```\n\n### Adicionando o tko no path\n\n```bash\n# adicione o path do pip para o bash\necho 'export PATH=\"$HOME/.local/bin:$PATH\"' >> ~/.bashrc\n```\n\n## Atualizando seu tko\n\nPara atualizar o tko para vers\u00e3o mais recente, basta executar o comando:\n\n```bash\npipx upgrade tko # codespace, arch, ubuntu e wsl\n```\n\n## Instalando os compiladores\n\n- Voc\u00ea pode utilizar qualquer outra linguagens que quiser, basta instalar o compilador correspondente e definir o comando de compila\u00e7\u00e3o e execu\u00e7\u00e3o correspondentes.\n\n### WSL e Ubuntu\n\n```bash\n# Java\nsudo apt install openjdk-11-jdk\n# Typescript\nsudo apt install nodejs npm\nnpm install --save-dev @types/node\nnpm install typescript esbuild readline-sync\n```\n\n### Arch\n\n```bash\n# Java\nsudo pacman -S jdk-openjdk\n# Typescript\nsudo pacman -S nodejs npm\nnpm install --save-dev @types/node\nnpm install typescript esbuild readline-sync\n```\n\n## Para interagir com os reposit\u00f3rios, navegar, baixar, testar\n\nOs `[]` e `<>` indicam onde devem ser colocados os par\u00e2metros. Os `|` indicam op\u00e7\u00f5es.\n\n```bash\n# primeiro crie um reposit\u00f3rio local na pasta local\ntko init --remote [poo | fup | ed]\n# exemplo tko init --remote fup\n\n# agora abra o reposit\u00f3rio para interagir com ele\ntko open <pasta_do_reposit\u00f3rio>\n# exemplo: tko open fup\n\n```\n\n## Programando em uma linguagem diferente de C, C++, Java, Python e Typescript\n\n- Qual for escolher a linguagem que deseja utilizar, escolha `yaml`. Na pasta de cada atividade ser\u00e1 criado um arquivo de rascunho chamado `draft.yaml` com os seguintes campos:\n\n```yaml\nbuild:\nrun:\n```\n\n- Preencha os campos `build` e `run` com os comandos de compila\u00e7\u00e3o e execu\u00e7\u00e3o da sua linguagem. Exemplo, em c++ para um arquivo fonte chamado solver.cpp, o `draft.yaml` ficaria assim:\n\n```yaml\nbuild: g++ -Wall solver.cpp -o solver.out\nrun: ./solver.out\n```\n\nAdapte para os comandos da sua linguagem e o nome dos arquivos da pasta.\n\n## Criando os testes\n\n### Descompactando os testes\n\nSe preferir trabalhar com o modelo de testes em arquivos separados, voc\u00ea pode descompactar o arquivo `cases.tio` para uma pasta com os arquivos de entrada e sa\u00edda. Ser\u00e1 gerado um arquivo `.in` e um `.sol` para cada teste.\n\n```bash\n$ mkdir pasta\n$ tko build pasta cases.tio\n$ ls pasta\n00.in 00.sol 01.in 01.sol 02.in 02.sol 03.in 03.sol 04.in 04.sol\n```\n\nPara rodar a partir da pasta com os testes descompactados, basta passar o nome da pasta como par\u00e2metro.\n\n```bash\ntko run Solver.java pasta\n```\n\nSe quiser utilizar um nome padr\u00e3o diferente para leitura ou escrita das pastas, veja a se\u00e7\u00e3o de [Convertendo entre formatos](#convertendo-entre-formatos).\n\n## Convertendo entre formatos\n\n- Gerando um `t.vpl`\n - `tko build t.vpl testes.tio`\n- Gerando um `t.tio` a partir do `Readme.md`e de um `extra.tio`.\n - `tko build t.tio Readme.md extra.tio`\n- Para extrair os testes para uma pasta com um arquivo para entrada e outro para sa\u00edda, crie uma pasta vazia e passe para o primeiro par\u00e2metro do `tko build`.\n\n```bash\n$ ls\ncases.tio draft.c Readme.md\n$ mkdir pasta\n$ tko build pasta cases.tio \n$ ls pasta/\n00.in 02.sol 05.in 07.sol 10.in 12.sol 15.in 17.sol 20.in 22.sol\n00.sol 03.in 05.sol 08.in 10.sol 13.in 15.sol 18.in 20.sol 23.in\n01.in 03.sol 06.in 08.sol 11.in 13.sol 16.in 18.sol 21.in 23.sol\n01.sol 04.in 06.sol 09.in 11.sol 14.in 16.sol 19.in 21.sol\n02.in 04.sol 07.in 09.sol 12.in 14.sol 17.in 19.sol 22.in\n```\n\n- Voc\u00ea pode definir o padr\u00e3o de nome dos arquivos gerados com `-p \"@ @\"`, sendo @ o wildcard que representa a numera\u00e7\u00e3o dos arquivo.\n - Vamos refazer o comando acima, mas colocando \"-p in.@ out.@\"\n\n```bash\n$ tko build pasta/ cases.tio -p \"in.@ out.@\"\n$ ls pasta/\nin.00 in.05 in.10 in.15 in.20 out.01 out.06 out.11 out.16 out.21\nin.01 in.06 in.11 in.16 in.21 out.02 out.07 out.12 out.17 out.22\nin.02 in.07 in.12 in.17 in.22 out.03 out.08 out.13 out.18 out.23\nin.03 in.08 in.13 in.18 in.23 out.04 out.09 out.14 out.19\nin.04 in.09 in.14 in.19 out.00 out.05 out.10 out.15 out.20\n```\n\n- O `pattern` \u00e9 \u00fatil para converter os formatos de Maratona, que vem em m\u00faltiplos arquivos para o `.tio`. Basta fazer o `match` do modelo que eles utilizarem.\n - `-p \"@.in @.out\"`\n - `-p \"in@ out@\"`\n - entre outros.\n",
"bugtrack_url": null,
"license": null,
"summary": "tko: Test Kit Operations",
"version": "2.5.1",
"project_urls": {
"Bug Reports": "https://github.com/senapk/tko/issues",
"Homepage": "https://github.com/senapk/tko",
"Source": "https://github.com/senapk/tko/"
},
"split_keywords": [
"programming",
" learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f9586a25cff671ea89f5d7c48d5847f900ea2027d086158dfea08ab9f2afb0a7",
"md5": "313bebb1547b5c275ef57ce1e677efe5",
"sha256": "87751a5ef8e00f56bbb4d733ed80f1dc6a69c248cd8173840055ea2e5bdaf0c7"
},
"downloads": -1,
"filename": "tko-2.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "313bebb1547b5c275ef57ce1e677efe5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 126208,
"upload_time": "2024-12-20T04:30:08",
"upload_time_iso_8601": "2024-12-20T04:30:08.215379Z",
"url": "https://files.pythonhosted.org/packages/f9/58/6a25cff671ea89f5d7c48d5847f900ea2027d086158dfea08ab9f2afb0a7/tko-2.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3c115ef69e00b543de6f37650a9a26d7712033b10dcf5261337e5cb6268b70c8",
"md5": "0933198b4f7472ab45c8fee7a96568ff",
"sha256": "43c3671cbae76c1764c4c21d933a620a30ea6672563cf77b82da7393df796d13"
},
"downloads": -1,
"filename": "tko-2.5.1.tar.gz",
"has_sig": false,
"md5_digest": "0933198b4f7472ab45c8fee7a96568ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 116133,
"upload_time": "2024-12-20T04:30:11",
"upload_time_iso_8601": "2024-12-20T04:30:11.042327Z",
"url": "https://files.pythonhosted.org/packages/3c/11/5ef69e00b543de6f37650a9a26d7712033b10dcf5261337e5cb6268b70c8/tko-2.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 04:30:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "senapk",
"github_project": "tko",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "appdirs",
"specs": []
},
{
"name": "types-appdirs",
"specs": []
},
{
"name": "pydot",
"specs": []
},
{
"name": "chardet",
"specs": []
},
{
"name": "types-chardet",
"specs": []
},
{
"name": "diff_match_patch",
"specs": []
},
{
"name": "uniplot",
"specs": []
},
{
"name": "build",
"specs": []
},
{
"name": "twine",
"specs": []
}
],
"lcname": "tko"
}
JSON
