Update README.md

This commit is contained in:
Erik 2019-10-30 10:02:12 -07:00 committed by GitHub
parent 626131176c
commit 87ed2a23f7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,45 +1,46 @@
# ical2csv # ical2csv
![alt text](images/ics.png) → ![alt text](images/python.png) → ![alt text](images/csv.png) ![alt text](images/ics.png) → ![alt text](images/python.png) → ![alt text](images/csv.png)
A command line Python script that will read an ics file and write it's contents to a csv file. A command line Python script that will read an ics file and write it's contents to a csv file.
## Installation ## Installation
Download the `ical2csv.py` file. Download the `ical2csv.py` file.
### Dependencies: ### Dependencies:
* ***icalendar*** * ***icalendar***
* [**Homepage**](http://icalendar.readthedocs.org/) * [**Homepage**](http://icalendar.readthedocs.org/)
* [**Code**](http://github.com/collective/icalendar) * [**Code**](http://github.com/collective/icalendar)
* **Installation**: `pip install icalendar` * **Installation**: `pip install icalendar`
* ***Python* 2** * ***Python* 3**
## Usage ## Usage
Call the script and pass in the location of the ics file. Call the script and pass in the location of the ics file.
Ex: `python ical2csv event.ics` Ex: `python ical2csv event.ics`
## Contributing ## Contributing
1. Fork it! 1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature 2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature' 3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature 4. Push to the branch: git push origin my-new-feature
5. Submit a pull request 😊 5. Submit a pull request 😊
## Credits ## Credits
Lead Developer - [Erik Cox]([https://github.com/erikcox/](https://github.com/erikcox/)) Lead Developer - [Erik Cox]([https://github.com/erikcox/](https://github.com/erikcox/))
Python 3 compatibility and improvements - [bozoslivehere]([https://github.com/bozoslivehere/])
## License
## License
The MIT License (MIT)
The MIT License (MIT)
Copyright (c) 2016 Erik Cox
Copyright (c) 2019 Erik Cox
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.