https://github.com/jaswdr/faker
:rocket: Ultimate fake data generator for Go with zero dependencies
https://github.com/jaswdr/faker
contributions-welcome fake fake-data faker faker-generator go golang hacktoberfest hacktoberfest-accepted hacktoberfest2021 hacktoberfest2022 hacktoberfest2023 hacktoberfest2024 open-source
Last synced: 23 days ago
JSON representation
:rocket: Ultimate fake data generator for Go with zero dependencies
- Host: GitHub
- URL: https://github.com/jaswdr/faker
- Owner: jaswdr
- License: mit
- Created: 2018-03-21T20:46:48.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T13:12:09.000Z (6 months ago)
- Last Synced: 2024-12-30T07:51:55.513Z (4 months ago)
- Topics: contributions-welcome, fake, fake-data, faker, faker-generator, go, golang, hacktoberfest, hacktoberfest-accepted, hacktoberfest2021, hacktoberfest2022, hacktoberfest2023, hacktoberfest2024, open-source
- Language: Go
- Homepage: https://pkg.go.dev/github.com/jaswdr/faker
- Size: 3.45 MB
- Stars: 574
- Watchers: 7
- Forks: 59
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- zero - faker
- awesome-hacking-lists - jaswdr/faker - :rocket: Ultimate fake data generator for Go with zero dependencies (Go)
README
Faker is a Go library that generates fake data for you. Whether you need to bootstrap your database, create good-looking XML documents, fill-in your persistence to stress test it, or anonymize data taken from a production service, Faker is for you.
Faker is heavily inspired by PHP"s [Faker](https://github.com/fzaninotto/Faker)
Faker requires Go >= 1.11 and < 1.20 for 1.X and Go >= 1.20 for 2.X
[](https://pkg.go.dev/github.com/jaswdr/faker)
[](https://github.com/jaswdr/faker/actions/workflows/test.yml)
[](https://codecov.io/gh/jaswdr/faker)
[](https://goreportcard.com/report/github.com/jaswdr/faker)
[](https://app.codacy.com/gh/jaswdr/faker?utm_source=github.com&utm_medium=referral&utm_content=jaswdr/faker&utm_campaign=Badge_Grade)
[](https://www.codefactor.io/repository/github/jaswdr/faker)
[](https://github.com/jaswdr/faker/releases)
[](https://gitpod.io/#https://github.com/jaswdr/faker)
[](https://hits.seeyoufarm.com)## Test it directly from your browser
Start at [https://play.golang.org/p/JpTagDGBaHK](https://go.dev/play/p/lMAvp_uyM8r)
## Installation
Add this to your Go file
```go
import "github.com/jaswdr/faker/v2"
```And run `go get` or `dep ensure` to get the package.
## Basic Usage
Use `faker.New()` to create and initialize a faker generator, which can generate data by accessing properties named after the type of data you want.
```go
import "github.com/jaswdr/faker/v2"func main() {
fake := faker.New()fake.Person().Name()
// Lucy Cechtelarfake.Address().Address()
// 426 Jordy Lodgefake.Lorem().Text(100)
// Dolores sit sint laboriosam dolorem culpa et autem. Beatae nam sunt fugit
// et sit et mollitia sed.
// Fuga deserunt tempora facere magni omnis. Omnis quia temporibus laudantium
// sit minima sint.
}
```Even if this example shows a method access, each call to `fake.Name()` yields a different (random) result.
```go
p := fake.Person()for i:=0; i < 10; i++ {
fmt.Println(p.Name())
}
// Adaline Reichel
// Dr. Santa Prosacco DVM
// Noemy Vandervort V
// Lexi O"Conner
// Gracie Weber
// Roscoe Johns
// Emmett Lebsack
// Keegan Thiel
// Wellington Koelpin II
// Ms. Karley Kiehn V
```You can also generate a profile image.
```go
image := p.Image()fmt.Println(image.Name())
// /tmp/profil-picture-img-1064677774.jfiffmt.Printf("%+v", image)
// &{file:0xc0002e4300}
```Generate fake data using Structs
```go
type ExampleStruct struct {
SimpleStringField string
SimpleNumber int
SimpleBool bool
SomeFormatedString string `fake:"??? ###"`
SomeStringArray [5]string `fake:"????"`
}example := ExampleStruct{}
f.Struct().Fill(&example)
fmt.Printf("%+v", example)
//{SimpleStringField:87576a01c2a547b2bbf9b7c736d1db40 SimpleNumber:9223372036854775807 SimpleBool:false SomeFormatedString:cxo 321 SomeStringArray:[effr swxp ldnj obcs nvlg]}
```Generate random placeholder images using [LoremFlickr](https://loremflickr.com/)
```go
// get a *os.File pointing to a file that is a random image
image := f.LoremFlickr().Image(100, 100, []string{}, "", false)fmt.Println(image.Name())
// /tmp/loremflickr-img-4101493944.jpg
```Generate profile images using [ThisPersonDoesNotExist](https://thispersondoesnotexist.com/)
```go
profileImage := f.ProfileImage().Image()fmt.Println(profileImage.Name())
// /tmp/profil-picture-img-4022222298.jfif
```See more formatters in [docs](https://pkg.go.dev/github.com/jaswdr/faker?tab=doc)
## Development
Create a fork and get the code.
```bash
$ go get github.com/jaswdr/faker/v2
```Do your changes, add tests, run the tests.
```bash
$ go test
PASS
ok github.com/jaswdr/faker/v2 2.966s
```Push to your fork and send a new pull request from your fork to this repository.
## Versioning
Faker is maintained under the [Semantic Versioning guidelines](http://semver.org/). Starting at `2.X`, we only support maintained versions of Go. Which according to [Go's Release Policy](https://go.dev/doc/devel/release) means that we only support the two newer major versions.
## License
Faker is released under the MIT Licence. See the bundled LICENSE file for details.
## Maintainer
Created and maitained by Jonathan Schweder ([@jaswdr](https://github.com/jaswdr)) and [many others](https://github.com/jaswdr/faker/graphs/contributors)