Update package details

This commit is contained in:
allegroai 2023-07-05 08:15:47 +03:00
parent 8f2342d4fd
commit 36b8c7cfbc
3 changed files with 11 additions and 81 deletions

2
.gitignore vendored
View File

@ -61,3 +61,5 @@ docs/_build/
# PyBuilder
target/
.idea/

View File

@ -1,83 +1,11 @@
# **wexpect**
# **wexpect-venv**
[![Build status](https://ci.appveyor.com/api/projects/status/tbji72d5s0tagrt9?svg=true)](https://ci.appveyor.com/project/raczben/wexpect)
[![codecov](https://codecov.io/gh/raczben/wexpect/branch/master/graph/badge.svg)](https://codecov.io/gh/raczben/wexpect)
[![Documentation Status](https://readthedocs.org/projects/wexpect/badge/?version=latest)](https://wexpect.readthedocs.io/en/latest/?badge=latest)
*Wexpect-venv* is a fork of *Wexpect*, a Windows variant of [pexpect](https://pexpect.readthedocs.io/en/stable/).
*Wexpect* is a Windows variant of [pexpect](https://pexpect.readthedocs.io/en/stable/).
*Wexpect-venv* was forked to provide a package to address [this](https://github.com/raczben/wexpect/issues/26#issuecomment-1574339194) issue, based on the *Wexpect* `dev` branch.
*Pexpect* is a Python module for spawning child applications and controlling
them automatically.
## You need wexpect if...
- you want to control any windows console application from python script.
- you want to write test-automation script for a windows console application.
- you want to automate your job by controlling multiple application parallel, synchronously.
For more information, see [Wexpect](https://github.com/raczben/wexpect)
## **Install**
pip install wexpect
## **Usage**
To interract with a child process use `spawn` method:
```python
import wexpect
prompt = '[A-Z]\:.+>'
child = wexpect.spawn('cmd.exe')
child.expect(prompt) # Wait for startup prompt
child.sendline('dir') # List the current directory
child.expect(prompt)
print(child.before) # Print the list
child.sendline('exit')
```
For more information see [examples](./examples) folder.
---
## REFACTOR
**Refactor has been finished!!!** The default spawn class is `SpawnPipe` from now. For more
information read [history](https://wexpect.readthedocs.io/en/latest/history.html#refactor).
---
## What is wexpect?
Wexpect is a Python module for spawning child applications and controlling
them automatically. Wexpect can be used for automating interactive applications
such as ssh, ftp, passwd, telnet, etc. It can be used to a automate setup
scripts for duplicating software package installations on different servers. It
can be used for automated software testing. Wexpect is in the spirit of Don
Libes' Expect, but Wexpect is pure Python. Other Expect-like modules for Python
require TCL and Expect or require C extensions to be compiled. Wexpect does not
use C, Expect, or TCL extensions.
Original Pexpect should work on any platform that supports the standard Python pty module. While
Wexpect works on Windows platforms. The Wexpect interface focuses on ease of use so that simple
tasks are easy.
---
## Dev
Thanks for any contributing!
### Test
To run test, enter into the folder of the wexpect's repo then:
`python -m unittest`
### Deploy
The deployment itself is automated and done by [appveyor](https://ci.appveyor.com/project/raczben/wexpect).
See `after_test` section in [appveyor.yml](appveyor.yml) for more details.
The wexpect uses [pbr](https://docs.openstack.org/pbr/latest/) for managing releasing procedures.
The versioning is handled by the pbr. The *"master-version"* is the git tag. Pbr derives the package
version from the git tags.
pip install wexpect-venv

View File

@ -1,13 +1,13 @@
[metadata]
name = wexpect
name = wexpect-venv
author = Noah Spurrier, Richard Holden, Marco Molteni, Kimberley Burchett, Robert Stone, Hartmut Goebel, Chad Schroeder, Erick Tryzelaar, Dave Kirby, Ids vander Molen, George Todd, Noel Taylor, Nicolas D. Cesar, Alexander Gattin, Geoffrey Marshall, Francisco Lourenco, Glen Mabey, Karthik Gurusamy, Fernando Perez, Corey Minyard, Jon Cohen, Guillaume Chazarain, Andrew Ryan, Nick Craig-Wood, Andrew Stone, Jorgen Grahn, Benedek Racz
author-email = betontalpfa@gmail.com
summary = Windows alternative of pexpect
author-email = info@clear.ml
summary = Fork of WExpect, a Windows alternative of pexpect
description-file = README.md
long-description-content-type = text/markdown
requires-python = >=3.4
project_urls =
Source Code = https://github.com/raczben/wexpect
Source Code = https://github.com/allegroai/wexpect-venv
license = MIT
classifier =
Development Status :: 4 - Beta