segmind / segmind-npm

Js client for Segmind

Installation

pip3 install -r requirements.txt

Code style

Python

We adopt PEP8 as the preferred code style.

We use the following tools for linting and formatting:

• flake8: linter
• yapf: formatter
• isort: sort imports

Style configurations of yapf and isort can be found in setup.cfg.

We use pre-commit hook that checks and formats for flake8, yapf, isort, trailing whitespaces, fixes end-of-files, sorts requirments.txt automatically on every commit. The config for a pre-commit hook is stored in .pre-commit-config.

After you clone the repository, you will need to install initialize pre-commit hook.

pip install -U pre-commit

From the repository folder

pre-commit install

After this on every commit check code linters and formatter will be enforced.

Run locally

cd .

pip install virtualenv

virtualenv venv

source ./venv/bin/activate

pip install -r requirements.txt pip install -e .

segmind-npm's Issues

Add `responseType: "stream"` to the POST request of the EsrGan API

return axios({
  url: this.url,
  data: JSON.stringify(data),
  method: "post",
  responseType: "stream",
  headers: {
    "Access-Control-Allow-Origin": "*",
    "Content-Type": "application/json",
    "x-api-key": `${this.apiKey}`,
   },
})

The data returned by the API is in a binary string format.

Adding responseType: "stream" makes the return type as an object. This helps in parsing the response and downloading the image returned by the API by calling the pipe().

export const EnhanceImage = async (image: string) => {
  esr.generate({
      image,
    })
    .then((response) => {
      if (response.status === 200) {
        const saveDirectory = "./enhanced_images"
        const fileName = 'downloaded_image.jpg'

        if (!fs.existsSync(saveDirectory)) {
          fs.mkdirSync(saveDirectory, { recursive: true })
        }

        const filePath = path.join(saveDirectory, fileName)

        const writer = fs.createWriteStream(filePath)
        response.data.pipe(writer)

        return new Promise((resolve, reject) => {
          writer.on("finish", resolve)
          writer.on("error", reject)
        })
      }
    })
    .catch((err) => console.log(err))
}

Vega & VegaRT Clents

When can we expect Vega & VegaRT Clients to be added to this SDK?

Thanks in advance

Change package name from segmind-npm to segmind

It would be better if we get npm install segmind instead of npm install segmind-npm.