gonhentai

GOnhentai

A simple GoLang library for nHentai
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

GOnhentai is a simple generic library that tries to create a base for all programs written in GO that use data from the nhentai site.

This library introduces new features, including the management of comments and some user features (WIP).

Getting Started

To download and start using the library follow these simple:

Prerequisites

• go >=1.16

Installation

go get github.com/KiritoNya/gonhentai

Usage

Let's now see how the library is used with some small examples of common use.

Doujinshi info

// Create Doujinshi object and get some information
doujin, err := gonhentai.NewDoujinshiId(354862)
if err != nil {
	panic(err)
}

fmt.Println("Doujinshi:", doujin)

Doujinshi Page Image

// Create Object
doujin, err := gonhentai.NewDoujinshiId(354862)
if err != nil {
panic(err)
}

page := doujin.Pages[35]

// Generate the url of page
err := page.GetUrl()
if err != nil {
	panic(err)
}

// Get the data of page image
err := page.GetData()
if err != nil {
	panic(err)
}

fmt.Println("DATA:", page.Data)

Comments

// Create Doujinshi object and get some information
doujin, err := gonhentai.NewDoujinshiId(354862)
if err != nil {
	panic(err)
}

// Get comments
err := doujin.GetComments()
if err != nil {
	panic(err)
}

fmt.Println("Comments:", doujin.Comments)

Download Page Image

The library already provides you a method to download the image and save it on your PC. Set the UseProgressBar variable to true if you decide to use the progress bar. Set ProgressBarTemplate variable If you want to use your progress bar defined by pb template.

// Create Doujinshi object
doujin, err := gonhentai.NewDoujinshiId(354862)
if err != nil {
	panic(err)
}

page := doujin.Pages[36]

// Generate url of page
err := page.GetUrl()
if err != nil {
	panic(err)
}

// Default is false
// Set it to true if you want a progress bar
gonhentai.UseProgressBar = true

// Use this code for set your progress bar template.
// gonhentai.ProgressBarTemplate = `{{ red "With funcs:" }} {{ bar . "<" "-" (cycle . "↖" "↗" "↘" "↙" ) "." ">"}} {{speed . | rndcolor }} {{percent .}} {{string . "my_green_string" | green}} {{string . "my_blue_string" | blue}}`

// Download image
err := page.Save("./img.jpg", 0644)
if err != nil {
	panic(err)
}

Download Doujinshi

To download a doujinshi a path is required which must be provided via a template. To form your path you can use all the fields of the Doujinshi object and all the fields of the page object, adding respectively .Doujinshi, .Page.

EX: /home/<username>/{{.Doujinshi.Id}} - {{.Doujinshi.Title.Pretty}}/{{.Page.Num}}.{{.Page.Ext}}

// Create Doujinshi object
doujin, err := gonhentai.NewDoujinshiId(354862)
if err != nil {
panic(err)
}

// You can use also
pathTemplate := gonhentai.DefaultDoujinNameTemplate + "/" + nehentai.DefaultPageNameTemplate

// Save doujinshi
err = d.Save("/home/<username/" + pathTemplate, 0644)
if err != nil {
t.Fatal(err)
}

fmt.Println("Doujinshi saved!")

Search

// Simple search
qr, err := nhentai.Search("Blend s", nhentai.QueryOptions{Page: "1"})
if err != nil {
	panic(err)
}
fmt.Println(qr)

// Tagged search
qr, err = nhentai.SearchTag(29859, nhentai.QueryOptions{Page: "1"})
if err != nil {
    panic(err)
}
fmt.Println(qr)

// Custom search
qr, err := nhentai.SearchCustom("Blend s", nhentai.QueryFilter {
    ToDelete: []nhentai.Filter{
        {
            Id:   0,
            Name: "yaoi",
            Type: nhentai.Tag,
        },
	},
    ToFilter: []nhentai.Filter{
        {
            Id:   0,
            Name: "maika sakuranomiya",
            Type: nhentai.Character,
        },
    },
})

// Check error
if err != nil {
    panic(err)
}
fmt.Println(qr)

For more examples, please refer to the Documentation

TODO

• Random sauce
• User Info
• Authenticate
• Favourites
• Generate PDF
• Generate CBR/CBZ
• Tags list

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

KiritoNya - @YuriLov95141178 - watashiwayuridaisuki@gmail.com

Anilist: KiritnoNya